Package com.oracle.bmc.managementdashboard.requests

Class ImportDashboardRequest.Builder

java.lang.Object

com.oracle.bmc.managementdashboard.requests.ImportDashboardRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ImportDashboardRequest,ManagementDashboardImportDetails>

Enclosing class:

ImportDashboardRequest

public static class ImportDashboardRequest.Builder
extends Object
implements BmcRequest.Builder<ImportDashboardRequest,ManagementDashboardImportDetails>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ImportDashboardRequest.Builder	body$(ManagementDashboardImportDetails body)	Alternative setter for the body parameter.
ImportDashboardRequest	build()	Build the instance of ImportDashboardRequest as configured by this builder
ImportDashboardRequest	buildWithoutInvocationCallback()	Build the instance of ImportDashboardRequest as configured by this builder
ImportDashboardRequest.Builder	copy(ImportDashboardRequest o)	Copy method to populate the builder with values from the given instance.
ImportDashboardRequest.Builder	ifMatch(String ifMatch)	For optimistic concurrency control.
ImportDashboardRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ImportDashboardRequest.Builder	managementDashboardImportDetails(ManagementDashboardImportDetails managementDashboardImportDetails)	JSON metadata for importing dashboards and their saved searches.
ImportDashboardRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ImportDashboardRequest.Builder	opcRetryToken(String opcRetryToken)	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.
ImportDashboardRequest.Builder	overrideDashboardCompartmentOcid(String overrideDashboardCompartmentOcid)	If this attribute is set, the dashboard resources are created or updated in the compartment specified by OCID.
ImportDashboardRequest.Builder	overrideSameName(String overrideSameName)	By default, if a resource with the same OCID exists in the target compartment, it is updated during the import process, otherwise, a new resource is created.
ImportDashboardRequest.Builder	overrideSavedSearchCompartmentOcid(String overrideSavedSearchCompartmentOcid)	If this attribute is set, the saved search resources are created or updated in the compartment specified by OCID.
ImportDashboardRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

managementDashboardImportDetails

public ImportDashboardRequest.Builder managementDashboardImportDetails(ManagementDashboardImportDetails managementDashboardImportDetails)

JSON metadata for importing dashboards and their saved searches.

Parameters:

managementDashboardImportDetails - the value to set

Returns:

this builder instance

ifMatch

public ImportDashboardRequest.Builder ifMatch(String ifMatch)

For optimistic concurrency control.

In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.

Parameters:

ifMatch - the value to set

Returns:

this builder instance

opcRetryToken

public ImportDashboardRequest.Builder opcRetryToken(String opcRetryToken)

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Parameters:

opcRetryToken - the value to set

Returns:

this builder instance

opcRequestId

public ImportDashboardRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

overrideSameName

public ImportDashboardRequest.Builder overrideSameName(String overrideSameName)

By default, if a resource with the same OCID exists in the target compartment, it is updated during the import process, otherwise, a new resource is created.

However, if this attribute is set to true, then during the import process if a resource with the same displayName exists in the compartment, then it is updated even if the OCIDs are different. This is useful when importing the same resource multiple times. If the compartment and displayName remain the same, the resource is only updated and multiple copies of a resource are not created.

Parameters:

overrideSameName - the value to set

Returns:

this builder instance

overrideDashboardCompartmentOcid

public ImportDashboardRequest.Builder overrideDashboardCompartmentOcid(String overrideDashboardCompartmentOcid)

If this attribute is set, the dashboard resources are created or updated in the compartment specified by OCID.

If this attribute is not set, the compartment specified in the JSON metadata is used.

Parameters:

overrideDashboardCompartmentOcid - the value to set

Returns:

this builder instance

overrideSavedSearchCompartmentOcid

public ImportDashboardRequest.Builder overrideSavedSearchCompartmentOcid(String overrideSavedSearchCompartmentOcid)

If this attribute is set, the saved search resources are created or updated in the compartment specified by OCID.

If this attribute is not set, the compartment specified in the JSON metadata is used.

Parameters:

overrideSavedSearchCompartmentOcid - the value to set

Returns:

this builder instance

invocationCallback

public ImportDashboardRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ImportDashboardRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ImportDashboardRequest.Builder copy(ImportDashboardRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ImportDashboardRequest,ManagementDashboardImportDetails>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ImportDashboardRequest build()

Build the instance of ImportDashboardRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ImportDashboardRequest,ManagementDashboardImportDetails>

Returns:

instance of ImportDashboardRequest

body$

public ImportDashboardRequest.Builder body$(ManagementDashboardImportDetails body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<ImportDashboardRequest,ManagementDashboardImportDetails>

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public ImportDashboardRequest buildWithoutInvocationCallback()

Build the instance of ImportDashboardRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ImportDashboardRequest