Class CloudDeploySettings (1.39.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

Static Methods

create(CloudDeployStubSettings stub)

public static final CloudDeploySettings create(CloudDeployStubSettings stub)
Parameter
NameDescription
stubCloudDeployStubSettings
Returns
TypeDescription
CloudDeploySettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static CloudDeploySettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
CloudDeploySettings.Builder

newBuilder(ClientContext clientContext)

public static CloudDeploySettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
CloudDeploySettings.Builder

newHttpJsonBuilder()

public static CloudDeploySettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
CloudDeploySettings.Builder

Constructors

CloudDeploySettings(CloudDeploySettings.Builder settingsBuilder)

protected CloudDeploySettings(CloudDeploySettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderCloudDeploySettings.Builder

Methods

abandonReleaseSettings()

public UnaryCallSettings<AbandonReleaseRequest,AbandonReleaseResponse> abandonReleaseSettings()

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

advanceRolloutSettings()

public UnaryCallSettings<AdvanceRolloutRequest,AdvanceRolloutResponse> advanceRolloutSettings()

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

approveRolloutSettings()

public UnaryCallSettings<ApproveRolloutRequest,ApproveRolloutResponse> approveRolloutSettings()

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

cancelAutomationRunSettings()

public UnaryCallSettings<CancelAutomationRunRequest,CancelAutomationRunResponse> cancelAutomationRunSettings()

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

cancelRolloutSettings()

public UnaryCallSettings<CancelRolloutRequest,CancelRolloutResponse> cancelRolloutSettings()

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

createAutomationOperationSettings()

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

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

createAutomationSettings()

public UnaryCallSettings<CreateAutomationRequest,Operation> createAutomationSettings()

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

createCustomTargetTypeOperationSettings()

public OperationCallSettings<CreateCustomTargetTypeRequest,CustomTargetType,OperationMetadata> createCustomTargetTypeOperationSettings()

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

createCustomTargetTypeSettings()

public UnaryCallSettings<CreateCustomTargetTypeRequest,Operation> createCustomTargetTypeSettings()

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

createDeliveryPipelineOperationSettings()

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

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

createDeliveryPipelineSettings()

public UnaryCallSettings<CreateDeliveryPipelineRequest,Operation> createDeliveryPipelineSettings()

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

createReleaseOperationSettings()

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

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

createReleaseSettings()

public UnaryCallSettings<CreateReleaseRequest,Operation> createReleaseSettings()

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

createRolloutOperationSettings()

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

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

createRolloutSettings()

public UnaryCallSettings<CreateRolloutRequest,Operation> createRolloutSettings()

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

createTargetOperationSettings()

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

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

createTargetSettings()

public UnaryCallSettings<CreateTargetRequest,Operation> createTargetSettings()

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

deleteAutomationOperationSettings()

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

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

deleteAutomationSettings()

public UnaryCallSettings<DeleteAutomationRequest,Operation> deleteAutomationSettings()

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

deleteCustomTargetTypeOperationSettings()

public OperationCallSettings<DeleteCustomTargetTypeRequest,Empty,OperationMetadata> deleteCustomTargetTypeOperationSettings()

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

deleteCustomTargetTypeSettings()

public UnaryCallSettings<DeleteCustomTargetTypeRequest,Operation> deleteCustomTargetTypeSettings()

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

deleteDeliveryPipelineOperationSettings()

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

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

deleteDeliveryPipelineSettings()

public UnaryCallSettings<DeleteDeliveryPipelineRequest,Operation> deleteDeliveryPipelineSettings()

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

deleteTargetOperationSettings()

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

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

deleteTargetSettings()

public UnaryCallSettings<DeleteTargetRequest,Operation> deleteTargetSettings()

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

getAutomationRunSettings()

public UnaryCallSettings<GetAutomationRunRequest,AutomationRun> getAutomationRunSettings()

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

getAutomationSettings()

public UnaryCallSettings<GetAutomationRequest,Automation> getAutomationSettings()

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

getConfigSettings()

public UnaryCallSettings<GetConfigRequest,Config> getConfigSettings()

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

getCustomTargetTypeSettings()

public UnaryCallSettings<GetCustomTargetTypeRequest,CustomTargetType> getCustomTargetTypeSettings()

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

getDeliveryPipelineSettings()

public UnaryCallSettings<GetDeliveryPipelineRequest,DeliveryPipeline> getDeliveryPipelineSettings()

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

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
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.

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
TypeDescription
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.

getRolloutSettings()

public UnaryCallSettings<GetRolloutRequest,Rollout> getRolloutSettings()

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

getTargetSettings()

public UnaryCallSettings<GetTargetRequest,Target> getTargetSettings()

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

ignoreJobSettings()

public UnaryCallSettings<IgnoreJobRequest,IgnoreJobResponse> ignoreJobSettings()

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

listAutomationRunsSettings()

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

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

listAutomationsSettings()

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

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

listCustomTargetTypesSettings()

public PagedCallSettings<ListCustomTargetTypesRequest,ListCustomTargetTypesResponse,CloudDeployClient.ListCustomTargetTypesPagedResponse> listCustomTargetTypesSettings()

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

listDeliveryPipelinesSettings()

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

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

listJobRunsSettings()

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

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

listLocationsSettings()

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

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

Returns
TypeDescription
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.

listRolloutsSettings()

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

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

listTargetsSettings()

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

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

retryJobSettings()

public UnaryCallSettings<RetryJobRequest,RetryJobResponse> retryJobSettings()

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

rollbackTargetSettings()

public UnaryCallSettings<RollbackTargetRequest,RollbackTargetResponse> rollbackTargetSettings()

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

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
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.

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
TypeDescription
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
TypeDescription
CloudDeploySettings.Builder
Overrides

updateAutomationOperationSettings()

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

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

updateAutomationSettings()

public UnaryCallSettings<UpdateAutomationRequest,Operation> updateAutomationSettings()

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

updateCustomTargetTypeOperationSettings()

public OperationCallSettings<UpdateCustomTargetTypeRequest,CustomTargetType,OperationMetadata> updateCustomTargetTypeOperationSettings()

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

updateCustomTargetTypeSettings()

public UnaryCallSettings<UpdateCustomTargetTypeRequest,Operation> updateCustomTargetTypeSettings()

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

updateDeliveryPipelineOperationSettings()

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

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

updateDeliveryPipelineSettings()

public UnaryCallSettings<UpdateDeliveryPipelineRequest,Operation> updateDeliveryPipelineSettings()

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

updateTargetOperationSettings()

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

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

updateTargetSettings()

public UnaryCallSettings<UpdateTargetRequest,Operation> updateTargetSettings()

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