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 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
CloudDeployStubSettings.Builder cloudDeploySettingsBuilder =
CloudDeployStubSettings.newBuilder();
cloudDeploySettingsBuilder
.getDeliveryPipelineSettings()
.setRetrySettings(
cloudDeploySettingsBuilder
.getDeliveryPipelineSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
CloudDeployStubSettings cloudDeploySettings = cloudDeploySettingsBuilder.build();
Static Methods
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()
getDefaultEndpoint()
public static String getDefaultEndpoint()
Returns the default service endpoint.
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint()
Returns the default mTLS service endpoint.
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
newBuilder()
public static CloudDeployStubSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
newBuilder(ClientContext clientContext)
public static CloudDeployStubSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
newHttpJsonBuilder()
public static CloudDeployStubSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
Constructors
CloudDeployStubSettings(CloudDeployStubSettings.Builder settingsBuilder)
protected CloudDeployStubSettings(CloudDeployStubSettings.Builder settingsBuilder)
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.
cancelRolloutSettings()
public UnaryCallSettings<CancelRolloutRequest,CancelRolloutResponse> cancelRolloutSettings()
Returns the object with the settings used for calls to cancelRollout.
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.
createStub()
public CloudDeployStub createStub()
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.
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.
getConfigSettings()
public UnaryCallSettings<GetConfigRequest,Config> getConfigSettings()
Returns the object with the settings used for calls to getConfig.
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 |
|---|
| 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.
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.
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.
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.
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.
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.
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 CloudDeployStubSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
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.
