com.google.cloud.orgpolicy.v2

Class OrgPolicySettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<OrgPolicySettings>

com.google.cloud.orgpolicy.v2.OrgPolicySettings

@Generated(value="by gapic-generator-java")
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 total timeout of getPolicy to 30 seconds:

 OrgPolicySettings.Builder orgPolicySettingsBuilder = OrgPolicySettings.newBuilder();
 orgPolicySettingsBuilder
     .getPolicySettings()
     .setRetrySettings(
         orgPolicySettingsBuilder
             .getPolicySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 OrgPolicySettings orgPolicySettings = orgPolicySettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrgPolicySettings.Builder Builder for OrgPolicySettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OrgPolicySettings(OrgPolicySettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static OrgPolicySettings	create(OrgPolicyStubSettings stub)
UnaryCallSettings<CreatePolicyRequest,Policy>	createPolicySettings() Returns the object with the settings used for calls to createPolicy.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<DeletePolicyRequest,Empty>	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.
UnaryCallSettings<GetEffectivePolicyRequest,Policy>	getEffectivePolicySettings() Returns the object with the settings used for calls to getEffectivePolicy.
UnaryCallSettings<GetPolicyRequest,Policy>	getPolicySettings() Returns the object with the settings used for calls to getPolicy.
PagedCallSettings<ListConstraintsRequest,ListConstraintsResponse,OrgPolicyClient.ListConstraintsPagedResponse>	listConstraintsSettings() Returns the object with the settings used for calls to listConstraints.
PagedCallSettings<ListPoliciesRequest,ListPoliciesResponse,OrgPolicyClient.ListPoliciesPagedResponse>	listPoliciesSettings() Returns the object with the settings used for calls to listPolicies.
static OrgPolicySettings.Builder	newBuilder() Returns a new builder for this class.
static OrgPolicySettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
OrgPolicySettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<UpdatePolicyRequest,Policy>	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, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OrgPolicySettings

protected OrgPolicySettings(OrgPolicySettings.Builder settingsBuilder)
                     throws IOException

Throws:

IOException

Method Detail

listConstraintsSettings

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

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

listPoliciesSettings

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

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

getPolicySettings

public UnaryCallSettings<GetPolicyRequest,Policy> getPolicySettings()

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

getEffectivePolicySettings

public UnaryCallSettings<GetEffectivePolicyRequest,Policy> getEffectivePolicySettings()

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

createPolicySettings

public UnaryCallSettings<CreatePolicyRequest,Policy> createPolicySettings()

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

updatePolicySettings

public UnaryCallSettings<UpdatePolicyRequest,Policy> updatePolicySettings()

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

deletePolicySettings

public UnaryCallSettings<DeletePolicyRequest,Empty> deletePolicySettings()

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

create

public static final OrgPolicySettings create(OrgPolicyStubSettings stub)
                                      throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static 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 GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static OrgPolicySettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static OrgPolicySettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public OrgPolicySettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<OrgPolicySettings>