Package com.google.cloud.deploy.v1.stub
Class CloudDeployStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<CloudDeployStubSettings>
com.google.cloud.deploy.v1.stub.CloudDeployStubSettings
@Generated("by gapic-generator-java")
public class CloudDeployStubSettings
extends StubSettings<CloudDeployStubSettings>
Settings class to configure an instance of
CloudDeployStub.
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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getDeliveryPipeline:
// 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
CloudDeployStubSettings.Builder cloudDeploySettingsBuilder =
CloudDeployStubSettings.newBuilder();
cloudDeploySettingsBuilder
.getDeliveryPipelineSettings()
.setRetrySettings(
cloudDeploySettingsBuilder
.getDeliveryPipelineSettings()
.getRetrySettings()
.toBuilder()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
CloudDeployStubSettings cloudDeploySettings = cloudDeploySettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createDeliveryPipeline:
// 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
CloudDeployStubSettings.Builder cloudDeploySettingsBuilder =
CloudDeployStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
cloudDeploySettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for CloudDeployStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCloudDeployStubSettings(CloudDeployStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to abandonRelease.Returns the object with the settings used for calls to advanceRollout.Returns the object with the settings used for calls to approveRollout.Returns the object with the settings used for calls to cancelAutomationRun.Returns the object with the settings used for calls to cancelRollout.Returns the object with the settings used for calls to createAutomation.Returns the object with the settings used for calls to createAutomation.Returns the object with the settings used for calls to createCustomTargetType.Returns the object with the settings used for calls to createCustomTargetType.Returns the object with the settings used for calls to createDeliveryPipeline.Returns the object with the settings used for calls to createDeliveryPipeline.Returns the object with the settings used for calls to createDeployPolicy.Returns the object with the settings used for calls to createDeployPolicy.Returns the object with the settings used for calls to createRelease.Returns the object with the settings used for calls to createRelease.Returns the object with the settings used for calls to createRollout.Returns the object with the settings used for calls to createRollout.Returns the object with the settings used for calls to createTarget.Returns the object with the settings used for calls to createTarget.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteAutomationRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteAutomation.Returns the object with the settings used for calls to deleteAutomation.OperationCallSettings<DeleteCustomTargetTypeRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteCustomTargetType.Returns the object with the settings used for calls to deleteCustomTargetType.OperationCallSettings<DeleteDeliveryPipelineRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteDeliveryPipeline.Returns the object with the settings used for calls to deleteDeliveryPipeline.OperationCallSettings<DeleteDeployPolicyRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteDeployPolicy.Returns the object with the settings used for calls to deleteDeployPolicy.OperationCallSettings<DeleteTargetRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteTarget.Returns the object with the settings used for calls to deleteTarget.Returns the object with the settings used for calls to getAutomationRun.Returns the object with the settings used for calls to getAutomation.Returns the object with the settings used for calls to getConfig.Returns the object with the settings used for calls to getCustomTargetType.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getDeliveryPipeline.Returns the object with the settings used for calls to getDeployPolicy.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getJobRun.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getRelease.Returns the object with the settings used for calls to getRollout.Returns the default service name.Returns the object with the settings used for calls to getTarget.Returns the object with the settings used for calls to ignoreJob.PagedCallSettings<ListAutomationRunsRequest,ListAutomationRunsResponse, CloudDeployClient.ListAutomationRunsPagedResponse> Returns the object with the settings used for calls to listAutomationRuns.PagedCallSettings<ListAutomationsRequest,ListAutomationsResponse, CloudDeployClient.ListAutomationsPagedResponse> Returns the object with the settings used for calls to listAutomations.PagedCallSettings<ListCustomTargetTypesRequest,ListCustomTargetTypesResponse, CloudDeployClient.ListCustomTargetTypesPagedResponse> Returns the object with the settings used for calls to listCustomTargetTypes.PagedCallSettings<ListDeliveryPipelinesRequest,ListDeliveryPipelinesResponse, CloudDeployClient.ListDeliveryPipelinesPagedResponse> Returns the object with the settings used for calls to listDeliveryPipelines.PagedCallSettings<ListDeployPoliciesRequest,ListDeployPoliciesResponse, CloudDeployClient.ListDeployPoliciesPagedResponse> Returns the object with the settings used for calls to listDeployPolicies.PagedCallSettings<ListJobRunsRequest,ListJobRunsResponse, CloudDeployClient.ListJobRunsPagedResponse> Returns the object with the settings used for calls to listJobRuns.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, CloudDeployClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListReleasesRequest,ListReleasesResponse, CloudDeployClient.ListReleasesPagedResponse> Returns the object with the settings used for calls to listReleases.PagedCallSettings<ListRolloutsRequest,ListRolloutsResponse, CloudDeployClient.ListRolloutsPagedResponse> Returns the object with the settings used for calls to listRollouts.PagedCallSettings<ListTargetsRequest,ListTargetsResponse, CloudDeployClient.ListTargetsPagedResponse> Returns the object with the settings used for calls to listTargets.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns the object with the settings used for calls to retryJob.Returns the object with the settings used for calls to rollbackTarget.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to terminateJobRun.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateAutomation.Returns the object with the settings used for calls to updateAutomation.Returns the object with the settings used for calls to updateCustomTargetType.Returns the object with the settings used for calls to updateCustomTargetType.Returns the object with the settings used for calls to updateDeliveryPipeline.Returns the object with the settings used for calls to updateDeliveryPipeline.Returns the object with the settings used for calls to updateDeployPolicy.Returns the object with the settings used for calls to updateDeployPolicy.Returns the object with the settings used for calls to updateTarget.Returns the object with the settings used for calls to updateTarget.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
CloudDeployStubSettings
protected CloudDeployStubSettings(CloudDeployStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listDeliveryPipelinesSettings
public PagedCallSettings<ListDeliveryPipelinesRequest,ListDeliveryPipelinesResponse, listDeliveryPipelinesSettings()CloudDeployClient.ListDeliveryPipelinesPagedResponse> Returns the object with the settings used for calls to listDeliveryPipelines. -
getDeliveryPipelineSettings
Returns the object with the settings used for calls to getDeliveryPipeline. -
createDeliveryPipelineSettings
Returns the object with the settings used for calls to createDeliveryPipeline. -
createDeliveryPipelineOperationSettings
public OperationCallSettings<CreateDeliveryPipelineRequest,DeliveryPipeline, createDeliveryPipelineOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createDeliveryPipeline. -
updateDeliveryPipelineSettings
Returns the object with the settings used for calls to updateDeliveryPipeline. -
updateDeliveryPipelineOperationSettings
public OperationCallSettings<UpdateDeliveryPipelineRequest,DeliveryPipeline, updateDeliveryPipelineOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateDeliveryPipeline. -
deleteDeliveryPipelineSettings
Returns the object with the settings used for calls to deleteDeliveryPipeline. -
deleteDeliveryPipelineOperationSettings
public OperationCallSettings<DeleteDeliveryPipelineRequest,com.google.protobuf.Empty, deleteDeliveryPipelineOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteDeliveryPipeline. -
listTargetsSettings
public PagedCallSettings<ListTargetsRequest,ListTargetsResponse, listTargetsSettings()CloudDeployClient.ListTargetsPagedResponse> Returns the object with the settings used for calls to listTargets. -
rollbackTargetSettings
Returns the object with the settings used for calls to rollbackTarget. -
getTargetSettings
Returns the object with the settings used for calls to getTarget. -
createTargetSettings
Returns the object with the settings used for calls to createTarget. -
createTargetOperationSettings
public OperationCallSettings<CreateTargetRequest,Target, createTargetOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createTarget. -
updateTargetSettings
Returns the object with the settings used for calls to updateTarget. -
updateTargetOperationSettings
public OperationCallSettings<UpdateTargetRequest,Target, updateTargetOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateTarget. -
deleteTargetSettings
Returns the object with the settings used for calls to deleteTarget. -
deleteTargetOperationSettings
public OperationCallSettings<DeleteTargetRequest,com.google.protobuf.Empty, deleteTargetOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteTarget. -
listCustomTargetTypesSettings
public PagedCallSettings<ListCustomTargetTypesRequest,ListCustomTargetTypesResponse, listCustomTargetTypesSettings()CloudDeployClient.ListCustomTargetTypesPagedResponse> Returns the object with the settings used for calls to listCustomTargetTypes. -
getCustomTargetTypeSettings
Returns the object with the settings used for calls to getCustomTargetType. -
createCustomTargetTypeSettings
Returns the object with the settings used for calls to createCustomTargetType. -
createCustomTargetTypeOperationSettings
public OperationCallSettings<CreateCustomTargetTypeRequest,CustomTargetType, createCustomTargetTypeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createCustomTargetType. -
updateCustomTargetTypeSettings
Returns the object with the settings used for calls to updateCustomTargetType. -
updateCustomTargetTypeOperationSettings
public OperationCallSettings<UpdateCustomTargetTypeRequest,CustomTargetType, updateCustomTargetTypeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateCustomTargetType. -
deleteCustomTargetTypeSettings
Returns the object with the settings used for calls to deleteCustomTargetType. -
deleteCustomTargetTypeOperationSettings
public OperationCallSettings<DeleteCustomTargetTypeRequest,com.google.protobuf.Empty, deleteCustomTargetTypeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteCustomTargetType. -
listReleasesSettings
public PagedCallSettings<ListReleasesRequest,ListReleasesResponse, listReleasesSettings()CloudDeployClient.ListReleasesPagedResponse> Returns the object with the settings used for calls to listReleases. -
getReleaseSettings
Returns the object with the settings used for calls to getRelease. -
createReleaseSettings
Returns the object with the settings used for calls to createRelease. -
createReleaseOperationSettings
public OperationCallSettings<CreateReleaseRequest,Release, createReleaseOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createRelease. -
abandonReleaseSettings
Returns the object with the settings used for calls to abandonRelease. -
createDeployPolicySettings
Returns the object with the settings used for calls to createDeployPolicy. -
createDeployPolicyOperationSettings
public OperationCallSettings<CreateDeployPolicyRequest,DeployPolicy, createDeployPolicyOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createDeployPolicy. -
updateDeployPolicySettings
Returns the object with the settings used for calls to updateDeployPolicy. -
updateDeployPolicyOperationSettings
public OperationCallSettings<UpdateDeployPolicyRequest,DeployPolicy, updateDeployPolicyOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateDeployPolicy. -
deleteDeployPolicySettings
Returns the object with the settings used for calls to deleteDeployPolicy. -
deleteDeployPolicyOperationSettings
public OperationCallSettings<DeleteDeployPolicyRequest,com.google.protobuf.Empty, deleteDeployPolicyOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteDeployPolicy. -
listDeployPoliciesSettings
public PagedCallSettings<ListDeployPoliciesRequest,ListDeployPoliciesResponse, listDeployPoliciesSettings()CloudDeployClient.ListDeployPoliciesPagedResponse> Returns the object with the settings used for calls to listDeployPolicies. -
getDeployPolicySettings
Returns the object with the settings used for calls to getDeployPolicy. -
approveRolloutSettings
Returns the object with the settings used for calls to approveRollout. -
advanceRolloutSettings
Returns the object with the settings used for calls to advanceRollout. -
cancelRolloutSettings
Returns the object with the settings used for calls to cancelRollout. -
listRolloutsSettings
public PagedCallSettings<ListRolloutsRequest,ListRolloutsResponse, listRolloutsSettings()CloudDeployClient.ListRolloutsPagedResponse> Returns the object with the settings used for calls to listRollouts. -
getRolloutSettings
Returns the object with the settings used for calls to getRollout. -
createRolloutSettings
Returns the object with the settings used for calls to createRollout. -
createRolloutOperationSettings
public OperationCallSettings<CreateRolloutRequest,Rollout, createRolloutOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createRollout. -
ignoreJobSettings
Returns the object with the settings used for calls to ignoreJob. -
retryJobSettings
Returns the object with the settings used for calls to retryJob. -
listJobRunsSettings
public PagedCallSettings<ListJobRunsRequest,ListJobRunsResponse, listJobRunsSettings()CloudDeployClient.ListJobRunsPagedResponse> Returns the object with the settings used for calls to listJobRuns. -
getJobRunSettings
Returns the object with the settings used for calls to getJobRun. -
terminateJobRunSettings
Returns the object with the settings used for calls to terminateJobRun. -
getConfigSettings
Returns the object with the settings used for calls to getConfig. -
createAutomationSettings
Returns the object with the settings used for calls to createAutomation. -
createAutomationOperationSettings
public OperationCallSettings<CreateAutomationRequest,Automation, createAutomationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createAutomation. -
updateAutomationSettings
Returns the object with the settings used for calls to updateAutomation. -
updateAutomationOperationSettings
public OperationCallSettings<UpdateAutomationRequest,Automation, updateAutomationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateAutomation. -
deleteAutomationSettings
Returns the object with the settings used for calls to deleteAutomation. -
deleteAutomationOperationSettings
public OperationCallSettings<DeleteAutomationRequest,com.google.protobuf.Empty, deleteAutomationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteAutomation. -
getAutomationSettings
Returns the object with the settings used for calls to getAutomation. -
listAutomationsSettings
public PagedCallSettings<ListAutomationsRequest,ListAutomationsResponse, listAutomationsSettings()CloudDeployClient.ListAutomationsPagedResponse> Returns the object with the settings used for calls to listAutomations. -
getAutomationRunSettings
Returns the object with the settings used for calls to getAutomationRun. -
listAutomationRunsSettings
public PagedCallSettings<ListAutomationRunsRequest,ListAutomationRunsResponse, listAutomationRunsSettings()CloudDeployClient.ListAutomationRunsPagedResponse> Returns the object with the settings used for calls to listAutomationRuns. -
cancelAutomationRunSettings
public UnaryCallSettings<CancelAutomationRunRequest,CancelAutomationRunResponse> cancelAutomationRunSettings()Returns the object with the settings used for calls to cancelAutomationRun. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()CloudDeployClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<CloudDeployStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<CloudDeployStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<CloudDeployStubSettings>
-