Package com.google.cloud.deploy.v1.stub

Class CloudDeployStubSettings

  • @Generated("by gapic-generator-java")
public class CloudDeployStubSettings
extends com.google.api.gax.rpc.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();

    • Method Detail

      • getDeliveryPipelineSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetDeliveryPipelineRequest,​DeliveryPipeline> getDeliveryPipelineSettings()
        Returns the object with the settings used for calls to getDeliveryPipeline.

      • createDeliveryPipelineSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateDeliveryPipelineRequest,​com.google.longrunning.Operation> createDeliveryPipelineSettings()
        Returns the object with the settings used for calls to createDeliveryPipeline.

      • updateDeliveryPipelineSettings

        public com.google.api.gax.rpc.UnaryCallSettings<UpdateDeliveryPipelineRequest,​com.google.longrunning.Operation> updateDeliveryPipelineSettings()
        Returns the object with the settings used for calls to updateDeliveryPipeline.

      • deleteDeliveryPipelineSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeleteDeliveryPipelineRequest,​com.google.longrunning.Operation> deleteDeliveryPipelineSettings()
        Returns the object with the settings used for calls to deleteDeliveryPipeline.

      • deleteDeliveryPipelineOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<DeleteDeliveryPipelineRequest,​com.google.protobuf.Empty,​OperationMetadata> deleteDeliveryPipelineOperationSettings()
        Returns the object with the settings used for calls to deleteDeliveryPipeline.

      • getTargetSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetTargetRequest,​Target> getTargetSettings()
        Returns the object with the settings used for calls to getTarget.

      • createTargetSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateTargetRequest,​com.google.longrunning.Operation> createTargetSettings()
        Returns the object with the settings used for calls to createTarget.

      • createTargetOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<CreateTargetRequest,​Target,​OperationMetadata> createTargetOperationSettings()
        Returns the object with the settings used for calls to createTarget.

      • updateTargetSettings

        public com.google.api.gax.rpc.UnaryCallSettings<UpdateTargetRequest,​com.google.longrunning.Operation> updateTargetSettings()
        Returns the object with the settings used for calls to updateTarget.

      • updateTargetOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<UpdateTargetRequest,​Target,​OperationMetadata> updateTargetOperationSettings()
        Returns the object with the settings used for calls to updateTarget.

      • deleteTargetSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeleteTargetRequest,​com.google.longrunning.Operation> deleteTargetSettings()
        Returns the object with the settings used for calls to deleteTarget.

      • deleteTargetOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<DeleteTargetRequest,​com.google.protobuf.Empty,​OperationMetadata> deleteTargetOperationSettings()
        Returns the object with the settings used for calls to deleteTarget.

      • getReleaseSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetReleaseRequest,​Release> getReleaseSettings()
        Returns the object with the settings used for calls to getRelease.

      • createReleaseSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateReleaseRequest,​com.google.longrunning.Operation> createReleaseSettings()
        Returns the object with the settings used for calls to createRelease.

      • createReleaseOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<CreateReleaseRequest,​Release,​OperationMetadata> createReleaseOperationSettings()
        Returns the object with the settings used for calls to createRelease.

      • abandonReleaseSettings

        public com.google.api.gax.rpc.UnaryCallSettings<AbandonReleaseRequest,​AbandonReleaseResponse> abandonReleaseSettings()
        Returns the object with the settings used for calls to abandonRelease.

      • approveRolloutSettings

        public com.google.api.gax.rpc.UnaryCallSettings<ApproveRolloutRequest,​ApproveRolloutResponse> approveRolloutSettings()
        Returns the object with the settings used for calls to approveRollout.

      • advanceRolloutSettings

        public com.google.api.gax.rpc.UnaryCallSettings<AdvanceRolloutRequest,​AdvanceRolloutResponse> advanceRolloutSettings()
        Returns the object with the settings used for calls to advanceRollout.

      • cancelRolloutSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CancelRolloutRequest,​CancelRolloutResponse> cancelRolloutSettings()
        Returns the object with the settings used for calls to cancelRollout.

      • getRolloutSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetRolloutRequest,​Rollout> getRolloutSettings()
        Returns the object with the settings used for calls to getRollout.

      • createRolloutSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateRolloutRequest,​com.google.longrunning.Operation> createRolloutSettings()
        Returns the object with the settings used for calls to createRollout.

      • createRolloutOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<CreateRolloutRequest,​Rollout,​OperationMetadata> createRolloutOperationSettings()
        Returns the object with the settings used for calls to createRollout.

      • ignoreJobSettings

        public com.google.api.gax.rpc.UnaryCallSettings<IgnoreJobRequest,​IgnoreJobResponse> ignoreJobSettings()
        Returns the object with the settings used for calls to ignoreJob.

      • retryJobSettings

        public com.google.api.gax.rpc.UnaryCallSettings<RetryJobRequest,​RetryJobResponse> retryJobSettings()
        Returns the object with the settings used for calls to retryJob.

      • getJobRunSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetJobRunRequest,​JobRun> getJobRunSettings()
        Returns the object with the settings used for calls to getJobRun.

      • getConfigSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetConfigRequest,​Config> getConfigSettings()
        Returns the object with the settings used for calls to getConfig.

      • listLocationsSettings

        public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,​com.google.cloud.location.ListLocationsResponse,​CloudDeployClient.ListLocationsPagedResponse> listLocationsSettings()
        Returns the object with the settings used for calls to listLocations.

      • getLocationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,​com.google.cloud.location.Location> getLocationSettings()
        Returns the object with the settings used for calls to getLocation.

      • setIamPolicySettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,​com.google.iam.v1.Policy> setIamPolicySettings()
        Returns the object with the settings used for calls to setIamPolicy.

      • getIamPolicySettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,​com.google.iam.v1.Policy> getIamPolicySettings()
        Returns the object with the settings used for calls to getIamPolicy.

      • testIamPermissionsSettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,​com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()
        Returns the object with the settings used for calls to testIamPermissions.

      • defaultExecutorProviderBuilder

        public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
        Returns a builder for the default ExecutorProvider for this service.

      • 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.

      • defaultCredentialsProviderBuilder

        public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
        Returns a builder for the default credentials for this service.

      • defaultGrpcTransportProviderBuilder

        public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
        Returns a builder for the default gRPC ChannelProvider for this service.

      • defaultHttpJsonTransportProviderBuilder

        @BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
        Returns a builder for the default REST ChannelProvider for this service.

      • defaultTransportChannelProvider

        public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

      • defaultGrpcApiClientHeaderProviderBuilder

        @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

      • defaultHttpJsonApiClientHeaderProviderBuilder

        @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

      • defaultApiClientHeaderProviderBuilder

        public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

      • newBuilder

        public static CloudDeployStubSettings.Builder newBuilder​(com.google.api.gax.rpc.ClientContext clientContext)
        Returns a new builder for this class.