Package com.google.cloud.config.v1

Class ConfigSettings

  • @Generated("by gapic-generator-java")
public class ConfigSettings
extends com.google.api.gax.rpc.ClientSettings<ConfigSettings>
    Settings class to configure an instance of ConfigClient.

    The default instance has everything set to sensible defaults:

    • The default service address (config.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 getDeployment 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
 ConfigSettings.Builder configSettingsBuilder = ConfigSettings.newBuilder();
 configSettingsBuilder
     .getDeploymentSettings()
     .setRetrySettings(
         configSettingsBuilder
             .getDeploymentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ConfigSettings configSettings = configSettingsBuilder.build();

    • Method Detail

      • getDeploymentSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetDeploymentRequest,​Deployment> getDeploymentSettings()
        Returns the object with the settings used for calls to getDeployment.

      • createDeploymentSettings

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

      • createDeploymentOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<CreateDeploymentRequest,​Deployment,​OperationMetadata> createDeploymentOperationSettings()
        Returns the object with the settings used for calls to createDeployment.

      • updateDeploymentSettings

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

      • updateDeploymentOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<UpdateDeploymentRequest,​Deployment,​OperationMetadata> updateDeploymentOperationSettings()
        Returns the object with the settings used for calls to updateDeployment.

      • deleteDeploymentSettings

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

      • deleteDeploymentOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<DeleteDeploymentRequest,​Deployment,​OperationMetadata> deleteDeploymentOperationSettings()
        Returns the object with the settings used for calls to deleteDeployment.

      • getRevisionSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetRevisionRequest,​Revision> getRevisionSettings()
        Returns the object with the settings used for calls to getRevision.

      • getResourceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetResourceRequest,​Resource> getResourceSettings()
        Returns the object with the settings used for calls to getResource.

      • exportDeploymentStatefileSettings

        public com.google.api.gax.rpc.UnaryCallSettings<ExportDeploymentStatefileRequest,​Statefile> exportDeploymentStatefileSettings()
        Returns the object with the settings used for calls to exportDeploymentStatefile.

      • exportRevisionStatefileSettings

        public com.google.api.gax.rpc.UnaryCallSettings<ExportRevisionStatefileRequest,​Statefile> exportRevisionStatefileSettings()
        Returns the object with the settings used for calls to exportRevisionStatefile.

      • importStatefileSettings

        public com.google.api.gax.rpc.UnaryCallSettings<ImportStatefileRequest,​Statefile> importStatefileSettings()
        Returns the object with the settings used for calls to importStatefile.

      • deleteStatefileSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeleteStatefileRequest,​com.google.protobuf.Empty> deleteStatefileSettings()
        Returns the object with the settings used for calls to deleteStatefile.

      • lockDeploymentSettings

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

      • lockDeploymentOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<LockDeploymentRequest,​Deployment,​OperationMetadata> lockDeploymentOperationSettings()
        Returns the object with the settings used for calls to lockDeployment.

      • unlockDeploymentSettings

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

      • unlockDeploymentOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<UnlockDeploymentRequest,​Deployment,​OperationMetadata> unlockDeploymentOperationSettings()
        Returns the object with the settings used for calls to unlockDeployment.

      • exportLockInfoSettings

        public com.google.api.gax.rpc.UnaryCallSettings<ExportLockInfoRequest,​LockInfo> exportLockInfoSettings()
        Returns the object with the settings used for calls to exportLockInfo.

      • listLocationsSettings

        public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,​com.google.cloud.location.ListLocationsResponse,​ConfigClient.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.

      • 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()

      • defaultApiClientHeaderProviderBuilder

        @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 defaultApiClientHeaderProviderBuilder()

      • newHttpJsonBuilder

        @BetaApi
public static ConfigSettings.Builder newHttpJsonBuilder()
        Returns a new REST builder for this class.

      • newBuilder

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

      • toBuilder

        public ConfigSettings.Builder toBuilder()
        Returns a builder containing all the values of this settings class.
        Specified by:
        toBuilder in class com.google.api.gax.rpc.ClientSettings<ConfigSettings>