Class CloudDeploySettings (1.28.0)

public class CloudDeploySettings extends ClientSettings<CloudDeploySettings>

Settings class to configure an instance of CloudDeployClient.

The default instance has everything set to sensible defaults:

The default service address (clouddeploy.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getDeliveryPipeline to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CloudDeploySettings.Builder cloudDeploySettingsBuilder = CloudDeploySettings.newBuilder();
 cloudDeploySettingsBuilder
     .getDeliveryPipelineSettings()
     .setRetrySettings(
         cloudDeploySettingsBuilder
             .getDeliveryPipelineSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudDeploySettings cloudDeploySettings = cloudDeploySettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > CloudDeploySettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(CloudDeployStubSettings stub)

public static final CloudDeploySettings create(CloudDeployStubSettings stub)

Parameter
Name	Description
`stub`	`CloudDeployStubSettings`

Returns
Type	Description
`CloudDeploySettings`

Exceptions
Type	Description
`IOException`

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
`Builder`

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
`Builder`

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type	Description
`Builder`

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type	Description
`Builder`

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
`TransportChannelProvider`

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
`String`

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
`List<String>`

newBuilder()

public static CloudDeploySettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
`CloudDeploySettings.Builder`

newBuilder(ClientContext clientContext)

public static CloudDeploySettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`CloudDeploySettings.Builder`

newHttpJsonBuilder()

public static CloudDeploySettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
`CloudDeploySettings.Builder`

Constructors

CloudDeploySettings(CloudDeploySettings.Builder settingsBuilder)

protected CloudDeploySettings(CloudDeploySettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`CloudDeploySettings.Builder`

Methods

abandonReleaseSettings()

public UnaryCallSettings<AbandonReleaseRequest,AbandonReleaseResponse> abandonReleaseSettings()

Returns the object with the settings used for calls to abandonRelease.

Returns
Type	Description
`UnaryCallSettings<AbandonReleaseRequest,AbandonReleaseResponse>`

advanceRolloutSettings()

public UnaryCallSettings<AdvanceRolloutRequest,AdvanceRolloutResponse> advanceRolloutSettings()

Returns the object with the settings used for calls to advanceRollout.

Returns
Type	Description
`UnaryCallSettings<AdvanceRolloutRequest,AdvanceRolloutResponse>`

approveRolloutSettings()

public UnaryCallSettings<ApproveRolloutRequest,ApproveRolloutResponse> approveRolloutSettings()

Returns the object with the settings used for calls to approveRollout.

Returns
Type	Description
`UnaryCallSettings<ApproveRolloutRequest,ApproveRolloutResponse>`

cancelAutomationRunSettings()

public UnaryCallSettings<CancelAutomationRunRequest,CancelAutomationRunResponse> cancelAutomationRunSettings()

Returns the object with the settings used for calls to cancelAutomationRun.

Returns
Type	Description
`UnaryCallSettings<CancelAutomationRunRequest,CancelAutomationRunResponse>`

cancelRolloutSettings()

public UnaryCallSettings<CancelRolloutRequest,CancelRolloutResponse> cancelRolloutSettings()

Returns the object with the settings used for calls to cancelRollout.

Returns
Type	Description
`UnaryCallSettings<CancelRolloutRequest,CancelRolloutResponse>`

createAutomationOperationSettings()

public OperationCallSettings<CreateAutomationRequest,Automation,OperationMetadata> createAutomationOperationSettings()

Returns the object with the settings used for calls to createAutomation.

Returns
Type	Description
`OperationCallSettings<CreateAutomationRequest,Automation,OperationMetadata>`

createAutomationSettings()

public UnaryCallSettings<CreateAutomationRequest,Operation> createAutomationSettings()

Returns the object with the settings used for calls to createAutomation.

Returns
Type	Description
`UnaryCallSettings<CreateAutomationRequest,Operation>`

createDeliveryPipelineOperationSettings()

public OperationCallSettings<CreateDeliveryPipelineRequest,DeliveryPipeline,OperationMetadata> createDeliveryPipelineOperationSettings()

Returns the object with the settings used for calls to createDeliveryPipeline.

Returns
Type	Description
`OperationCallSettings<CreateDeliveryPipelineRequest,DeliveryPipeline,OperationMetadata>`

createDeliveryPipelineSettings()

public UnaryCallSettings<CreateDeliveryPipelineRequest,Operation> createDeliveryPipelineSettings()

Returns the object with the settings used for calls to createDeliveryPipeline.

Returns
Type	Description
`UnaryCallSettings<CreateDeliveryPipelineRequest,Operation>`

createReleaseOperationSettings()

public OperationCallSettings<CreateReleaseRequest,Release,OperationMetadata> createReleaseOperationSettings()

Returns the object with the settings used for calls to createRelease.

Returns
Type	Description
`OperationCallSettings<CreateReleaseRequest,Release,OperationMetadata>`

createReleaseSettings()

public UnaryCallSettings<CreateReleaseRequest,Operation> createReleaseSettings()

Returns the object with the settings used for calls to createRelease.

Returns
Type	Description
`UnaryCallSettings<CreateReleaseRequest,Operation>`

createRolloutOperationSettings()

public OperationCallSettings<CreateRolloutRequest,Rollout,OperationMetadata> createRolloutOperationSettings()

Returns the object with the settings used for calls to createRollout.

Returns
Type	Description
`OperationCallSettings<CreateRolloutRequest,Rollout,OperationMetadata>`

createRolloutSettings()

public UnaryCallSettings<CreateRolloutRequest,Operation> createRolloutSettings()

Returns the object with the settings used for calls to createRollout.

Returns
Type	Description
`UnaryCallSettings<CreateRolloutRequest,Operation>`

createTargetOperationSettings()

public OperationCallSettings<CreateTargetRequest,Target,OperationMetadata> createTargetOperationSettings()

Returns the object with the settings used for calls to createTarget.

Returns
Type	Description
`OperationCallSettings<CreateTargetRequest,Target,OperationMetadata>`

createTargetSettings()

public UnaryCallSettings<CreateTargetRequest,Operation> createTargetSettings()

Returns the object with the settings used for calls to createTarget.

Returns
Type	Description
`UnaryCallSettings<CreateTargetRequest,Operation>`

deleteAutomationOperationSettings()

public OperationCallSettings<DeleteAutomationRequest,Empty,OperationMetadata> deleteAutomationOperationSettings()

Returns the object with the settings used for calls to deleteAutomation.

Returns
Type	Description
`OperationCallSettings<DeleteAutomationRequest,Empty,OperationMetadata>`

deleteAutomationSettings()

public UnaryCallSettings<DeleteAutomationRequest,Operation> deleteAutomationSettings()

Returns the object with the settings used for calls to deleteAutomation.

Returns
Type	Description
`UnaryCallSettings<DeleteAutomationRequest,Operation>`

deleteDeliveryPipelineOperationSettings()

public OperationCallSettings<DeleteDeliveryPipelineRequest,Empty,OperationMetadata> deleteDeliveryPipelineOperationSettings()

Returns the object with the settings used for calls to deleteDeliveryPipeline.

Returns
Type	Description
`OperationCallSettings<DeleteDeliveryPipelineRequest,Empty,OperationMetadata>`

deleteDeliveryPipelineSettings()

public UnaryCallSettings<DeleteDeliveryPipelineRequest,Operation> deleteDeliveryPipelineSettings()

Returns the object with the settings used for calls to deleteDeliveryPipeline.

Returns
Type	Description
`UnaryCallSettings<DeleteDeliveryPipelineRequest,Operation>`

deleteTargetOperationSettings()

public OperationCallSettings<DeleteTargetRequest,Empty,OperationMetadata> deleteTargetOperationSettings()

Returns the object with the settings used for calls to deleteTarget.

Returns
Type	Description
`OperationCallSettings<DeleteTargetRequest,Empty,OperationMetadata>`

deleteTargetSettings()

public UnaryCallSettings<DeleteTargetRequest,Operation> deleteTargetSettings()

Returns the object with the settings used for calls to deleteTarget.

Returns
Type	Description
`UnaryCallSettings<DeleteTargetRequest,Operation>`

getAutomationRunSettings()

public UnaryCallSettings<GetAutomationRunRequest,AutomationRun> getAutomationRunSettings()

Returns the object with the settings used for calls to getAutomationRun.

Returns
Type	Description
`UnaryCallSettings<GetAutomationRunRequest,AutomationRun>`

getAutomationSettings()

public UnaryCallSettings<GetAutomationRequest,Automation> getAutomationSettings()

Returns the object with the settings used for calls to getAutomation.

Returns
Type	Description
`UnaryCallSettings<GetAutomationRequest,Automation>`

getConfigSettings()

public UnaryCallSettings<GetConfigRequest,Config> getConfigSettings()

Returns the object with the settings used for calls to getConfig.

Returns
Type	Description
`UnaryCallSettings<GetConfigRequest,Config>`

getDeliveryPipelineSettings()

public UnaryCallSettings<GetDeliveryPipelineRequest,DeliveryPipeline> getDeliveryPipelineSettings()

Returns the object with the settings used for calls to getDeliveryPipeline.

Returns
Type	Description
`UnaryCallSettings<GetDeliveryPipelineRequest,DeliveryPipeline>`

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

Returns the object with the settings used for calls to getIamPolicy.

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`

getJobRunSettings()

public UnaryCallSettings<GetJobRunRequest,JobRun> getJobRunSettings()

Returns the object with the settings used for calls to getJobRun.

Returns
Type	Description
`UnaryCallSettings<GetJobRunRequest,JobRun>`

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

Returns the object with the settings used for calls to getLocation.

Returns
Type	Description
`UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getReleaseSettings()

public UnaryCallSettings<GetReleaseRequest,Release> getReleaseSettings()

Returns the object with the settings used for calls to getRelease.

Returns
Type	Description
`UnaryCallSettings<GetReleaseRequest,Release>`

getRolloutSettings()

public UnaryCallSettings<GetRolloutRequest,Rollout> getRolloutSettings()

Returns the object with the settings used for calls to getRollout.

Returns
Type	Description
`UnaryCallSettings<GetRolloutRequest,Rollout>`

getTargetSettings()

public UnaryCallSettings<GetTargetRequest,Target> getTargetSettings()

Returns the object with the settings used for calls to getTarget.

Returns
Type	Description
`UnaryCallSettings<GetTargetRequest,Target>`

ignoreJobSettings()

public UnaryCallSettings<IgnoreJobRequest,IgnoreJobResponse> ignoreJobSettings()

Returns the object with the settings used for calls to ignoreJob.

Returns
Type	Description
`UnaryCallSettings<IgnoreJobRequest,IgnoreJobResponse>`

listAutomationRunsSettings()

public PagedCallSettings<ListAutomationRunsRequest,ListAutomationRunsResponse,CloudDeployClient.ListAutomationRunsPagedResponse> listAutomationRunsSettings()

Returns the object with the settings used for calls to listAutomationRuns.

Returns
Type	Description
`PagedCallSettings<ListAutomationRunsRequest,ListAutomationRunsResponse,ListAutomationRunsPagedResponse>`

listAutomationsSettings()

public PagedCallSettings<ListAutomationsRequest,ListAutomationsResponse,CloudDeployClient.ListAutomationsPagedResponse> listAutomationsSettings()

Returns the object with the settings used for calls to listAutomations.

Returns
Type	Description
`PagedCallSettings<ListAutomationsRequest,ListAutomationsResponse,ListAutomationsPagedResponse>`

listDeliveryPipelinesSettings()

public PagedCallSettings<ListDeliveryPipelinesRequest,ListDeliveryPipelinesResponse,CloudDeployClient.ListDeliveryPipelinesPagedResponse> listDeliveryPipelinesSettings()

Returns the object with the settings used for calls to listDeliveryPipelines.

Returns
Type	Description
`PagedCallSettings<ListDeliveryPipelinesRequest,ListDeliveryPipelinesResponse,ListDeliveryPipelinesPagedResponse>`

listJobRunsSettings()

public PagedCallSettings<ListJobRunsRequest,ListJobRunsResponse,CloudDeployClient.ListJobRunsPagedResponse> listJobRunsSettings()

Returns the object with the settings used for calls to listJobRuns.

Returns
Type	Description
`PagedCallSettings<ListJobRunsRequest,ListJobRunsResponse,ListJobRunsPagedResponse>`

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,CloudDeployClient.ListLocationsPagedResponse> listLocationsSettings()

Returns the object with the settings used for calls to listLocations.

Returns
Type	Description
`PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>`

listReleasesSettings()

public PagedCallSettings<ListReleasesRequest,ListReleasesResponse,CloudDeployClient.ListReleasesPagedResponse> listReleasesSettings()

Returns the object with the settings used for calls to listReleases.

Returns
Type	Description
`PagedCallSettings<ListReleasesRequest,ListReleasesResponse,ListReleasesPagedResponse>`

listRolloutsSettings()

public PagedCallSettings<ListRolloutsRequest,ListRolloutsResponse,CloudDeployClient.ListRolloutsPagedResponse> listRolloutsSettings()

Returns the object with the settings used for calls to listRollouts.

Returns
Type	Description
`PagedCallSettings<ListRolloutsRequest,ListRolloutsResponse,ListRolloutsPagedResponse>`

listTargetsSettings()

public PagedCallSettings<ListTargetsRequest,ListTargetsResponse,CloudDeployClient.ListTargetsPagedResponse> listTargetsSettings()

Returns the object with the settings used for calls to listTargets.

Returns
Type	Description
`PagedCallSettings<ListTargetsRequest,ListTargetsResponse,ListTargetsPagedResponse>`

retryJobSettings()

public UnaryCallSettings<RetryJobRequest,RetryJobResponse> retryJobSettings()

Returns the object with the settings used for calls to retryJob.

Returns
Type	Description
`UnaryCallSettings<RetryJobRequest,RetryJobResponse>`

rollbackTargetSettings()

public UnaryCallSettings<RollbackTargetRequest,RollbackTargetResponse> rollbackTargetSettings()

Returns the object with the settings used for calls to rollbackTarget.

Returns
Type	Description
`UnaryCallSettings<RollbackTargetRequest,RollbackTargetResponse>`

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

Returns the object with the settings used for calls to setIamPolicy.

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`

terminateJobRunSettings()

public UnaryCallSettings<TerminateJobRunRequest,TerminateJobRunResponse> terminateJobRunSettings()

Returns the object with the settings used for calls to terminateJobRun.

Returns
Type	Description
`UnaryCallSettings<TerminateJobRunRequest,TerminateJobRunResponse>`

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

Returns the object with the settings used for calls to testIamPermissions.

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`

toBuilder()

public CloudDeploySettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type	Description
`CloudDeploySettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateAutomationOperationSettings()

public OperationCallSettings<UpdateAutomationRequest,Automation,OperationMetadata> updateAutomationOperationSettings()

Returns the object with the settings used for calls to updateAutomation.

Returns
Type	Description
`OperationCallSettings<UpdateAutomationRequest,Automation,OperationMetadata>`

updateAutomationSettings()

public UnaryCallSettings<UpdateAutomationRequest,Operation> updateAutomationSettings()

Returns the object with the settings used for calls to updateAutomation.

Returns
Type	Description
`UnaryCallSettings<UpdateAutomationRequest,Operation>`

updateDeliveryPipelineOperationSettings()

public OperationCallSettings<UpdateDeliveryPipelineRequest,DeliveryPipeline,OperationMetadata> updateDeliveryPipelineOperationSettings()

Returns the object with the settings used for calls to updateDeliveryPipeline.

Returns
Type	Description
`OperationCallSettings<UpdateDeliveryPipelineRequest,DeliveryPipeline,OperationMetadata>`

updateDeliveryPipelineSettings()

public UnaryCallSettings<UpdateDeliveryPipelineRequest,Operation> updateDeliveryPipelineSettings()

Returns the object with the settings used for calls to updateDeliveryPipeline.

Returns
Type	Description
`UnaryCallSettings<UpdateDeliveryPipelineRequest,Operation>`

updateTargetOperationSettings()

public OperationCallSettings<UpdateTargetRequest,Target,OperationMetadata> updateTargetOperationSettings()

Returns the object with the settings used for calls to updateTarget.

Returns
Type	Description
`OperationCallSettings<UpdateTargetRequest,Target,OperationMetadata>`

updateTargetSettings()

public UnaryCallSettings<UpdateTargetRequest,Operation> updateTargetSettings()

Returns the object with the settings used for calls to updateTarget.

Returns
Type	Description
`UnaryCallSettings<UpdateTargetRequest,Operation>`