Class OrgPolicySettings (2.52.0)

Version 2.52.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.7-SNAPSHOT
• 2.2.1
• 2.1.2
• 2.0.10

public class OrgPolicySettings extends ClientSettings<OrgPolicySettings>

Settings class to configure an instance of OrgPolicyClient.

The default instance has everything set to sensible defaults:

• The default service address (orgpolicy.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 of getPolicy:

 // 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
 OrgPolicySettings.Builder orgPolicySettingsBuilder = OrgPolicySettings.newBuilder();
 orgPolicySettingsBuilder
     .getPolicySettings()
     .setRetrySettings(
         orgPolicySettingsBuilder
             .getPolicySettings()
             .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());
 OrgPolicySettings orgPolicySettings = orgPolicySettingsBuilder.build();
 

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > ClientSettings > OrgPolicySettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(OrgPolicyStubSettings stub)

public static final OrgPolicySettings create(OrgPolicyStubSettings stub)

Parameter
Name	Description
stub	OrgPolicyStubSettings

Returns
Type	Description
OrgPolicySettings

Exceptions
Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
List<String>

newBuilder()

public static OrgPolicySettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
OrgPolicySettings.Builder

newBuilder(ClientContext clientContext)

public static OrgPolicySettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
OrgPolicySettings.Builder

newHttpJsonBuilder()

public static OrgPolicySettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
OrgPolicySettings.Builder

Constructors

OrgPolicySettings(OrgPolicySettings.Builder settingsBuilder)

protected OrgPolicySettings(OrgPolicySettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	OrgPolicySettings.Builder

Methods

createCustomConstraintSettings()

public UnaryCallSettings<CreateCustomConstraintRequest,CustomConstraint> createCustomConstraintSettings()

Returns the object with the settings used for calls to createCustomConstraint.

Returns
Type	Description
UnaryCallSettings<CreateCustomConstraintRequest,CustomConstraint>

createPolicySettings()

public UnaryCallSettings<CreatePolicyRequest,Policy> createPolicySettings()

Returns the object with the settings used for calls to createPolicy.

Returns
Type	Description
UnaryCallSettings<CreatePolicyRequest,Policy>

deleteCustomConstraintSettings()

public UnaryCallSettings<DeleteCustomConstraintRequest,Empty> deleteCustomConstraintSettings()

Returns the object with the settings used for calls to deleteCustomConstraint.

Returns
Type	Description
UnaryCallSettings<DeleteCustomConstraintRequest,Empty>

deletePolicySettings()

public UnaryCallSettings<DeletePolicyRequest,Empty> deletePolicySettings()

Returns the object with the settings used for calls to deletePolicy.

Returns
Type	Description
UnaryCallSettings<DeletePolicyRequest,Empty>

getCustomConstraintSettings()

public UnaryCallSettings<GetCustomConstraintRequest,CustomConstraint> getCustomConstraintSettings()

Returns the object with the settings used for calls to getCustomConstraint.

Returns
Type	Description
UnaryCallSettings<GetCustomConstraintRequest,CustomConstraint>

getEffectivePolicySettings()

public UnaryCallSettings<GetEffectivePolicyRequest,Policy> getEffectivePolicySettings()

Returns the object with the settings used for calls to getEffectivePolicy.

Returns
Type	Description
UnaryCallSettings<GetEffectivePolicyRequest,Policy>

getPolicySettings()

public UnaryCallSettings<GetPolicyRequest,Policy> getPolicySettings()

Returns the object with the settings used for calls to getPolicy.

Returns
Type	Description
UnaryCallSettings<GetPolicyRequest,Policy>

listConstraintsSettings()

public PagedCallSettings<ListConstraintsRequest,ListConstraintsResponse,OrgPolicyClient.ListConstraintsPagedResponse> listConstraintsSettings()

Returns the object with the settings used for calls to listConstraints.

Returns
Type	Description
PagedCallSettings<ListConstraintsRequest,ListConstraintsResponse,ListConstraintsPagedResponse>

listCustomConstraintsSettings()

public PagedCallSettings<ListCustomConstraintsRequest,ListCustomConstraintsResponse,OrgPolicyClient.ListCustomConstraintsPagedResponse> listCustomConstraintsSettings()

Returns the object with the settings used for calls to listCustomConstraints.

Returns
Type	Description
PagedCallSettings<ListCustomConstraintsRequest,ListCustomConstraintsResponse,ListCustomConstraintsPagedResponse>

listPoliciesSettings()

public PagedCallSettings<ListPoliciesRequest,ListPoliciesResponse,OrgPolicyClient.ListPoliciesPagedResponse> listPoliciesSettings()

Returns the object with the settings used for calls to listPolicies.

Returns
Type	Description
PagedCallSettings<ListPoliciesRequest,ListPoliciesResponse,ListPoliciesPagedResponse>

toBuilder()

public OrgPolicySettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type	Description
OrgPolicySettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateCustomConstraintSettings()

public UnaryCallSettings<UpdateCustomConstraintRequest,CustomConstraint> updateCustomConstraintSettings()

Returns the object with the settings used for calls to updateCustomConstraint.

Returns
Type	Description
UnaryCallSettings<UpdateCustomConstraintRequest,CustomConstraint>

updatePolicySettings()

public UnaryCallSettings<UpdatePolicyRequest,Policy> updatePolicySettings()

Returns the object with the settings used for calls to updatePolicy.

Returns
Type	Description
UnaryCallSettings<UpdatePolicyRequest,Policy>