Class MetadataServiceSettings (2.9.8)

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 (aiplatform.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 getMetadataStore to 30 seconds:


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

Inheritance

java.lang.Object > ClientSettings > MetadataServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

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 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 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

Constructors

MetadataServiceSettings(MetadataServiceSettings.Builder settingsBuilder)

protected MetadataServiceSettings(MetadataServiceSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`MetadataServiceSettings.Builder`

Methods

addContextArtifactsAndExecutionsSettings()

public UnaryCallSettings<AddContextArtifactsAndExecutionsRequest,AddContextArtifactsAndExecutionsResponse> addContextArtifactsAndExecutionsSettings()

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

Returns

Type	Description
UnaryCallSettings<AddContextArtifactsAndExecutionsRequest,AddContextArtifactsAndExecutionsResponse>

addContextChildrenSettings()

public UnaryCallSettings<AddContextChildrenRequest,AddContextChildrenResponse> addContextChildrenSettings()

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

Returns

Type	Description
UnaryCallSettings<AddContextChildrenRequest,AddContextChildrenResponse>

addExecutionEventsSettings()

public UnaryCallSettings<AddExecutionEventsRequest,AddExecutionEventsResponse> addExecutionEventsSettings()

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

Returns

Type	Description
UnaryCallSettings<AddExecutionEventsRequest,AddExecutionEventsResponse>

createArtifactSettings()

public UnaryCallSettings<CreateArtifactRequest,Artifact> createArtifactSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateArtifactRequest,Artifact>

createContextSettings()

public UnaryCallSettings<CreateContextRequest,Context> createContextSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateContextRequest,Context>

createExecutionSettings()

public UnaryCallSettings<CreateExecutionRequest,Execution> createExecutionSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateExecutionRequest,Execution>

createMetadataSchemaSettings()

public UnaryCallSettings<CreateMetadataSchemaRequest,MetadataSchema> createMetadataSchemaSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateMetadataSchemaRequest,MetadataSchema>

createMetadataStoreOperationSettings()

public OperationCallSettings<CreateMetadataStoreRequest,MetadataStore,CreateMetadataStoreOperationMetadata> createMetadataStoreOperationSettings()

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

Returns

Type	Description
OperationCallSettings<CreateMetadataStoreRequest,MetadataStore,CreateMetadataStoreOperationMetadata>

createMetadataStoreSettings()

public UnaryCallSettings<CreateMetadataStoreRequest,Operation> createMetadataStoreSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateMetadataStoreRequest,Operation>

deleteArtifactOperationSettings()

public OperationCallSettings<DeleteArtifactRequest,Empty,DeleteOperationMetadata> deleteArtifactOperationSettings()

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

Returns

Type	Description
OperationCallSettings<DeleteArtifactRequest,Empty,DeleteOperationMetadata>

deleteArtifactSettings()

public UnaryCallSettings<DeleteArtifactRequest,Operation> deleteArtifactSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteArtifactRequest,Operation>

deleteContextOperationSettings()

public OperationCallSettings<DeleteContextRequest,Empty,DeleteOperationMetadata> deleteContextOperationSettings()

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

Returns

Type	Description
OperationCallSettings<DeleteContextRequest,Empty,DeleteOperationMetadata>

deleteContextSettings()

public UnaryCallSettings<DeleteContextRequest,Operation> deleteContextSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteContextRequest,Operation>

deleteExecutionOperationSettings()

public OperationCallSettings<DeleteExecutionRequest,Empty,DeleteOperationMetadata> deleteExecutionOperationSettings()

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

Returns

Type	Description
OperationCallSettings<DeleteExecutionRequest,Empty,DeleteOperationMetadata>

deleteExecutionSettings()

public UnaryCallSettings<DeleteExecutionRequest,Operation> deleteExecutionSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteExecutionRequest,Operation>

deleteMetadataStoreOperationSettings()

public OperationCallSettings<DeleteMetadataStoreRequest,Empty,DeleteMetadataStoreOperationMetadata> deleteMetadataStoreOperationSettings()

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

Returns

Type	Description
OperationCallSettings<DeleteMetadataStoreRequest,Empty,DeleteMetadataStoreOperationMetadata>

deleteMetadataStoreSettings()

public UnaryCallSettings<DeleteMetadataStoreRequest,Operation> deleteMetadataStoreSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteMetadataStoreRequest,Operation>

getArtifactSettings()

public UnaryCallSettings<GetArtifactRequest,Artifact> getArtifactSettings()

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

Returns

Type	Description
UnaryCallSettings<GetArtifactRequest,Artifact>

getContextSettings()

public UnaryCallSettings<GetContextRequest,Context> getContextSettings()

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

Returns

Type	Description
UnaryCallSettings<GetContextRequest,Context>

getExecutionSettings()

public UnaryCallSettings<GetExecutionRequest,Execution> getExecutionSettings()

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

Returns

Type	Description
UnaryCallSettings<GetExecutionRequest,Execution>

getMetadataSchemaSettings()

public UnaryCallSettings<GetMetadataSchemaRequest,MetadataSchema> getMetadataSchemaSettings()

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

Returns

Type	Description
UnaryCallSettings<GetMetadataSchemaRequest,MetadataSchema>

getMetadataStoreSettings()

public UnaryCallSettings<GetMetadataStoreRequest,MetadataStore> getMetadataStoreSettings()

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

Returns

Type	Description
UnaryCallSettings<GetMetadataStoreRequest,MetadataStore>

listArtifactsSettings()

public PagedCallSettings<ListArtifactsRequest,ListArtifactsResponse,MetadataServiceClient.ListArtifactsPagedResponse> listArtifactsSettings()

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

Returns

Type	Description
PagedCallSettings<ListArtifactsRequest,ListArtifactsResponse,ListArtifactsPagedResponse>

listContextsSettings()

public PagedCallSettings<ListContextsRequest,ListContextsResponse,MetadataServiceClient.ListContextsPagedResponse> listContextsSettings()

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

Returns

Type	Description
PagedCallSettings<ListContextsRequest,ListContextsResponse,ListContextsPagedResponse>

listExecutionsSettings()

public PagedCallSettings<ListExecutionsRequest,ListExecutionsResponse,MetadataServiceClient.ListExecutionsPagedResponse> listExecutionsSettings()

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

Returns

Type	Description
PagedCallSettings<ListExecutionsRequest,ListExecutionsResponse,ListExecutionsPagedResponse>

listMetadataSchemasSettings()

public PagedCallSettings<ListMetadataSchemasRequest,ListMetadataSchemasResponse,MetadataServiceClient.ListMetadataSchemasPagedResponse> listMetadataSchemasSettings()

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

Returns

Type	Description
PagedCallSettings<ListMetadataSchemasRequest,ListMetadataSchemasResponse,ListMetadataSchemasPagedResponse>

listMetadataStoresSettings()

public PagedCallSettings<ListMetadataStoresRequest,ListMetadataStoresResponse,MetadataServiceClient.ListMetadataStoresPagedResponse> listMetadataStoresSettings()

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

Returns

Type	Description
PagedCallSettings<ListMetadataStoresRequest,ListMetadataStoresResponse,ListMetadataStoresPagedResponse>

purgeArtifactsOperationSettings()

public OperationCallSettings<PurgeArtifactsRequest,PurgeArtifactsResponse,PurgeArtifactsMetadata> purgeArtifactsOperationSettings()

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

Returns

Type	Description
OperationCallSettings<PurgeArtifactsRequest,PurgeArtifactsResponse,PurgeArtifactsMetadata>

purgeArtifactsSettings()

public UnaryCallSettings<PurgeArtifactsRequest,Operation> purgeArtifactsSettings()

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

Returns

Type	Description
UnaryCallSettings<PurgeArtifactsRequest,Operation>

purgeContextsOperationSettings()

public OperationCallSettings<PurgeContextsRequest,PurgeContextsResponse,PurgeContextsMetadata> purgeContextsOperationSettings()

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

Returns

Type	Description
OperationCallSettings<PurgeContextsRequest,PurgeContextsResponse,PurgeContextsMetadata>

purgeContextsSettings()

public UnaryCallSettings<PurgeContextsRequest,Operation> purgeContextsSettings()

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

Returns

Type	Description
UnaryCallSettings<PurgeContextsRequest,Operation>

purgeExecutionsOperationSettings()

public OperationCallSettings<PurgeExecutionsRequest,PurgeExecutionsResponse,PurgeExecutionsMetadata> purgeExecutionsOperationSettings()

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

Returns

Type	Description
OperationCallSettings<PurgeExecutionsRequest,PurgeExecutionsResponse,PurgeExecutionsMetadata>

purgeExecutionsSettings()

public UnaryCallSettings<PurgeExecutionsRequest,Operation> purgeExecutionsSettings()

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

Returns

Type	Description
UnaryCallSettings<PurgeExecutionsRequest,Operation>

queryArtifactLineageSubgraphSettings()

public UnaryCallSettings<QueryArtifactLineageSubgraphRequest,LineageSubgraph> queryArtifactLineageSubgraphSettings()

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

Returns

Type	Description
UnaryCallSettings<QueryArtifactLineageSubgraphRequest,LineageSubgraph>

queryContextLineageSubgraphSettings()

public UnaryCallSettings<QueryContextLineageSubgraphRequest,LineageSubgraph> queryContextLineageSubgraphSettings()

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

Returns

Type	Description
UnaryCallSettings<QueryContextLineageSubgraphRequest,LineageSubgraph>

queryExecutionInputsAndOutputsSettings()

public UnaryCallSettings<QueryExecutionInputsAndOutputsRequest,LineageSubgraph> queryExecutionInputsAndOutputsSettings()

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

Returns

Type	Description
UnaryCallSettings<QueryExecutionInputsAndOutputsRequest,LineageSubgraph>

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

updateArtifactSettings()

public UnaryCallSettings<UpdateArtifactRequest,Artifact> updateArtifactSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateArtifactRequest,Artifact>

updateContextSettings()

public UnaryCallSettings<UpdateContextRequest,Context> updateContextSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateContextRequest,Context>

updateExecutionSettings()

public UnaryCallSettings<UpdateExecutionRequest,Execution> updateExecutionSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateExecutionRequest,Execution>