Class MetadataServiceSettings (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 total timeout of createEntity to 30 seconds:


 MetadataServiceSettings.Builder metadataServiceSettingsBuilder =
     MetadataServiceSettings.newBuilder();
 metadataServiceSettingsBuilder
     .createEntitySettings()
     .setRetrySettings(
         metadataServiceSettingsBuilder
             .createEntitySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 MetadataServiceSettings metadataServiceSettings = metadataServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > MetadataServiceSettings

Static Methods

create(MetadataServiceStubSettings stub)

public static final MetadataServiceSettings create(MetadataServiceStubSettings stub)
Parameter
NameDescription
stubMetadataServiceStubSettings
Returns Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static MetadataServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

newBuilder(ClientContext clientContext)

public static MetadataServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns

Constructors

MetadataServiceSettings(MetadataServiceSettings.Builder settingsBuilder)

protected MetadataServiceSettings(MetadataServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderMetadataServiceSettings.Builder

Methods

createEntitySettings()

public UnaryCallSettings<CreateEntityRequest,Entity> createEntitySettings()

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

Returns

createPartitionSettings()

public UnaryCallSettings<CreatePartitionRequest,Partition> createPartitionSettings()

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

Returns

deleteEntitySettings()

public UnaryCallSettings<DeleteEntityRequest,Empty> deleteEntitySettings()

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

Returns

deletePartitionSettings()

public UnaryCallSettings<DeletePartitionRequest,Empty> deletePartitionSettings()

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

Returns

getEntitySettings()

public UnaryCallSettings<GetEntityRequest,Entity> getEntitySettings()

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

Returns

getPartitionSettings()

public UnaryCallSettings<GetPartitionRequest,Partition> getPartitionSettings()

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

Returns

listEntitiesSettings()

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

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

Returns

listPartitionsSettings()

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

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

Returns

toBuilder()

public MetadataServiceSettings.Builder toBuilder()

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

Returns Overrides

updateEntitySettings()

public UnaryCallSettings<UpdateEntityRequest,Entity> updateEntitySettings()

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

Returns