com.google.cloud.datacatalog.v1beta1

Class PolicyTagManagerSettings

java.lang.Object

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

com.google.cloud.datacatalog.v1beta1.PolicyTagManagerSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class PolicyTagManagerSettings
extends com.google.api.gax.rpc.ClientSettings<PolicyTagManagerSettings>

Settings class to configure an instance of PolicyTagManagerClient.

The default instance has everything set to sensible defaults:

• The default service address (datacatalog.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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of createTaxonomy:

 // 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
 PolicyTagManagerSettings.Builder policyTagManagerSettingsBuilder =
     PolicyTagManagerSettings.newBuilder();
 policyTagManagerSettingsBuilder
     .createTaxonomySettings()
     .setRetrySettings(
         policyTagManagerSettingsBuilder
             .createTaxonomySettings()
             .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());
 PolicyTagManagerSettings policyTagManagerSettings = policyTagManagerSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for additional support in setting retries.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static PolicyTagManagerSettings	create(PolicyTagManagerStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreatePolicyTagRequest,PolicyTag>	createPolicyTagSettings() Returns the object with the settings used for calls to createPolicyTag.
com.google.api.gax.rpc.UnaryCallSettings<CreateTaxonomyRequest,Taxonomy>	createTaxonomySettings() Returns the object with the settings used for calls to createTaxonomy.
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.UnaryCallSettings<DeletePolicyTagRequest,com.google.protobuf.Empty>	deletePolicyTagSettings() Returns the object with the settings used for calls to deletePolicyTag.
com.google.api.gax.rpc.UnaryCallSettings<DeleteTaxonomyRequest,com.google.protobuf.Empty>	deleteTaxonomySettings() Returns the object with the settings used for calls to deleteTaxonomy.
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.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<GetPolicyTagRequest,PolicyTag>	getPolicyTagSettings() Returns the object with the settings used for calls to getPolicyTag.
com.google.api.gax.rpc.UnaryCallSettings<GetTaxonomyRequest,Taxonomy>	getTaxonomySettings() Returns the object with the settings used for calls to getTaxonomy.
com.google.api.gax.rpc.PagedCallSettings<ListPolicyTagsRequest,ListPolicyTagsResponse,PolicyTagManagerClient.ListPolicyTagsPagedResponse>	listPolicyTagsSettings() Returns the object with the settings used for calls to listPolicyTags.
com.google.api.gax.rpc.PagedCallSettings<ListTaxonomiesRequest,ListTaxonomiesResponse,PolicyTagManagerClient.ListTaxonomiesPagedResponse>	listTaxonomiesSettings() Returns the object with the settings used for calls to listTaxonomies.
static PolicyTagManagerSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static PolicyTagManagerSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static PolicyTagManagerSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
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.
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.
PolicyTagManagerSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdatePolicyTagRequest,PolicyTag>	updatePolicyTagSettings() Returns the object with the settings used for calls to updatePolicyTag.
com.google.api.gax.rpc.UnaryCallSettings<UpdateTaxonomyRequest,Taxonomy>	updateTaxonomySettings() Returns the object with the settings used for calls to updateTaxonomy.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PolicyTagManagerSettings

protected PolicyTagManagerSettings(PolicyTagManagerSettings.Builder settingsBuilder)
                            throws IOException

Throws:

IOException

Method Detail

createTaxonomySettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateTaxonomyRequest,Taxonomy> createTaxonomySettings()

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

deleteTaxonomySettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteTaxonomyRequest,com.google.protobuf.Empty> deleteTaxonomySettings()

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

updateTaxonomySettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateTaxonomyRequest,Taxonomy> updateTaxonomySettings()

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

listTaxonomiesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTaxonomiesRequest,ListTaxonomiesResponse,PolicyTagManagerClient.ListTaxonomiesPagedResponse> listTaxonomiesSettings()

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

getTaxonomySettings

public com.google.api.gax.rpc.UnaryCallSettings<GetTaxonomyRequest,Taxonomy> getTaxonomySettings()

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

createPolicyTagSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreatePolicyTagRequest,PolicyTag> createPolicyTagSettings()

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

deletePolicyTagSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeletePolicyTagRequest,com.google.protobuf.Empty> deletePolicyTagSettings()

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

updatePolicyTagSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdatePolicyTagRequest,PolicyTag> updatePolicyTagSettings()

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

listPolicyTagsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListPolicyTagsRequest,ListPolicyTagsResponse,PolicyTagManagerClient.ListPolicyTagsPagedResponse> listPolicyTagsSettings()

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

getPolicyTagSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetPolicyTagRequest,PolicyTag> getPolicyTagSettings()

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

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.

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.

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.

create

public static final PolicyTagManagerSettings create(PolicyTagManagerStubSettings stub)
                                             throws IOException

Throws:

IOException

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

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

newBuilder

public static PolicyTagManagerSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static PolicyTagManagerSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static PolicyTagManagerSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public PolicyTagManagerSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<PolicyTagManagerSettings>