Class MetadataServiceSettings (1.51.0)

Version latest

• 1.51.0 (latest)
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.2
• 1.0.1
• 0.2.2

public class MetadataServiceSettings extends ClientSettings<MetadataServiceSettings>

Settings class to configure an instance of MetadataServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (dataplex.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 createEntity:

 // 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
 MetadataServiceSettings.Builder metadataServiceSettingsBuilder =
     MetadataServiceSettings.newBuilder();
 metadataServiceSettingsBuilder
     .createEntitySettings()
     .setRetrySettings(
         metadataServiceSettingsBuilder
             .createEntitySettings()
             .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());
 MetadataServiceSettings metadataServiceSettings = metadataServiceSettingsBuilder.build();
 

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

Inheritance

java.lang.Object > ClientSettings > MetadataServiceSettings

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(MetadataServiceStubSettings stub)

public static final MetadataServiceSettings create(MetadataServiceStubSettings stub)

Parameter
Name	Description
stub	MetadataServiceStubSettings

Returns
Type	Description
MetadataServiceSettings

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 MetadataServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
MetadataServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static MetadataServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
MetadataServiceSettings.Builder

newHttpJsonBuilder()

public static MetadataServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
MetadataServiceSettings.Builder

Constructors

MetadataServiceSettings(MetadataServiceSettings.Builder settingsBuilder)

protected MetadataServiceSettings(MetadataServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	MetadataServiceSettings.Builder

Methods

createEntitySettings()

public UnaryCallSettings<CreateEntityRequest,Entity> createEntitySettings()

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

Returns
Type	Description
UnaryCallSettings<CreateEntityRequest,Entity>

createPartitionSettings()

public UnaryCallSettings<CreatePartitionRequest,Partition> createPartitionSettings()

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

Returns
Type	Description
UnaryCallSettings<CreatePartitionRequest,Partition>

deleteEntitySettings()

public UnaryCallSettings<DeleteEntityRequest,Empty> deleteEntitySettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteEntityRequest,Empty>

deletePartitionSettings()

public UnaryCallSettings<DeletePartitionRequest,Empty> deletePartitionSettings()

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

Returns
Type	Description
UnaryCallSettings<DeletePartitionRequest,Empty>

getEntitySettings()

public UnaryCallSettings<GetEntityRequest,Entity> getEntitySettings()

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

Returns
Type	Description
UnaryCallSettings<GetEntityRequest,Entity>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getPartitionSettings()

public UnaryCallSettings<GetPartitionRequest,Partition> getPartitionSettings()

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

Returns
Type	Description
UnaryCallSettings<GetPartitionRequest,Partition>

listEntitiesSettings()

public PagedCallSettings<ListEntitiesRequest,ListEntitiesResponse,MetadataServiceClient.ListEntitiesPagedResponse> listEntitiesSettings()

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

Returns
Type	Description
PagedCallSettings<ListEntitiesRequest,ListEntitiesResponse,ListEntitiesPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,MetadataServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type	Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listPartitionsSettings()

public PagedCallSettings<ListPartitionsRequest,ListPartitionsResponse,MetadataServiceClient.ListPartitionsPagedResponse> listPartitionsSettings()

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

Returns
Type	Description
PagedCallSettings<ListPartitionsRequest,ListPartitionsResponse,ListPartitionsPagedResponse>

toBuilder()

public MetadataServiceSettings.Builder toBuilder()

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

Returns
Type	Description
MetadataServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateEntitySettings()

public UnaryCallSettings<UpdateEntityRequest,Entity> updateEntitySettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateEntityRequest,Entity>