Package com.google.iam.v2beta

Class PoliciesSettings

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

    The default instance has everything set to sensible defaults:

    • The default service address (iam.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 getPolicy 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
 PoliciesSettings.Builder policiesSettingsBuilder = PoliciesSettings.newBuilder();
 policiesSettingsBuilder
     .getPolicySettings()
     .setRetrySettings(
         policiesSettingsBuilder
             .getPolicySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PoliciesSettings policiesSettings = policiesSettingsBuilder.build();

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PoliciesSettings.Builder
      Builder for PoliciesSettings.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static PoliciesSettings create​(PoliciesStubSettings stub)  
      com.google.api.gax.rpc.OperationCallSettings<com.google.iam.v2beta.CreatePolicyRequest,​com.google.iam.v2beta.Policy,​com.google.iam.v2beta.PolicyOperationMetadata> createPolicyOperationSettings()
      Returns the object with the settings used for calls to createPolicy.
      com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v2beta.CreatePolicyRequest,​com.google.longrunning.Operation> createPolicySettings()
      Returns the object with the settings used for calls to createPolicy.
      static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()  
      static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
      Returns a builder for the default credentials for this service.
      static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
      Returns a builder for the default ExecutorProvider for this service.
      static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
      Returns a builder for the default gRPC ChannelProvider for this service.
      static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
      Returns a builder for the default REST ChannelProvider for this service.
      static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()  
      com.google.api.gax.rpc.OperationCallSettings<com.google.iam.v2beta.DeletePolicyRequest,​com.google.iam.v2beta.Policy,​com.google.iam.v2beta.PolicyOperationMetadata> deletePolicyOperationSettings()
      Returns the object with the settings used for calls to deletePolicy.
      com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v2beta.DeletePolicyRequest,​com.google.longrunning.Operation> deletePolicySettings()
      Returns the object with the settings used for calls to deletePolicy.
      static String getDefaultEndpoint()
      Returns the default service endpoint.
      static List<String> getDefaultServiceScopes()
      Returns the default service scopes.
      com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v2beta.GetPolicyRequest,​com.google.iam.v2beta.Policy> getPolicySettings()
      Returns the object with the settings used for calls to getPolicy.
      com.google.api.gax.rpc.PagedCallSettings<com.google.iam.v2beta.ListPoliciesRequest,​com.google.iam.v2beta.ListPoliciesResponse,​PoliciesClient.ListPoliciesPagedResponse> listPoliciesSettings()
      Returns the object with the settings used for calls to listPolicies.
      static PoliciesSettings.Builder newBuilder()
      Returns a new gRPC builder for this class.
      static PoliciesSettings.Builder newBuilder​(com.google.api.gax.rpc.ClientContext clientContext)
      Returns a new builder for this class.
      static PoliciesSettings.Builder newHttpJsonBuilder()
      Returns a new REST builder for this class.
      PoliciesSettings.Builder toBuilder()
      Returns a builder containing all the values of this settings class.
      com.google.api.gax.rpc.OperationCallSettings<com.google.iam.v2beta.UpdatePolicyRequest,​com.google.iam.v2beta.Policy,​com.google.iam.v2beta.PolicyOperationMetadata> updatePolicyOperationSettings()
      Returns the object with the settings used for calls to updatePolicy.
      com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v2beta.UpdatePolicyRequest,​com.google.longrunning.Operation> updatePolicySettings()
      Returns the object with the settings used for calls to updatePolicy.

      • Methods inherited from class com.google.api.gax.rpc.ClientSettings

        getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

    • Method Detail

      • listPoliciesSettings

        public com.google.api.gax.rpc.PagedCallSettings<com.google.iam.v2beta.ListPoliciesRequest,​com.google.iam.v2beta.ListPoliciesResponse,​PoliciesClient.ListPoliciesPagedResponse> listPoliciesSettings()
        Returns the object with the settings used for calls to listPolicies.

      • getPolicySettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v2beta.GetPolicyRequest,​com.google.iam.v2beta.Policy> getPolicySettings()
        Returns the object with the settings used for calls to getPolicy.

      • createPolicySettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v2beta.CreatePolicyRequest,​com.google.longrunning.Operation> createPolicySettings()
        Returns the object with the settings used for calls to createPolicy.

      • createPolicyOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<com.google.iam.v2beta.CreatePolicyRequest,​com.google.iam.v2beta.Policy,​com.google.iam.v2beta.PolicyOperationMetadata> createPolicyOperationSettings()
        Returns the object with the settings used for calls to createPolicy.

      • updatePolicySettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v2beta.UpdatePolicyRequest,​com.google.longrunning.Operation> updatePolicySettings()
        Returns the object with the settings used for calls to updatePolicy.

      • updatePolicyOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<com.google.iam.v2beta.UpdatePolicyRequest,​com.google.iam.v2beta.Policy,​com.google.iam.v2beta.PolicyOperationMetadata> updatePolicyOperationSettings()
        Returns the object with the settings used for calls to updatePolicy.

      • deletePolicySettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v2beta.DeletePolicyRequest,​com.google.longrunning.Operation> deletePolicySettings()
        Returns the object with the settings used for calls to deletePolicy.

      • deletePolicyOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<com.google.iam.v2beta.DeletePolicyRequest,​com.google.iam.v2beta.Policy,​com.google.iam.v2beta.PolicyOperationMetadata> deletePolicyOperationSettings()
        Returns the object with the settings used for calls to deletePolicy.

      • 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 PoliciesSettings.Builder newHttpJsonBuilder()
        Returns a new REST builder for this class.

      • newBuilder

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

      • toBuilder

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