Class MetadataServiceSettings (3.16.0)

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:


 // 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
     .getMetadataStoreSettings()
     .setRetrySettings(
         metadataServiceSettingsBuilder
             .getMetadataStoreSettings()
             .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
TypeDescription
MetadataServiceSettings
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
TypeDescription
TransportChannelProvider

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
TypeDescription
MetadataServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static MetadataServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
MetadataServiceSettings.Builder

Constructors

MetadataServiceSettings(MetadataServiceSettings.Builder settingsBuilder)

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

Methods

addContextArtifactsAndExecutionsSettings()

public UnaryCallSettings<AddContextArtifactsAndExecutionsRequest,AddContextArtifactsAndExecutionsResponse> addContextArtifactsAndExecutionsSettings()

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

Returns
TypeDescription
UnaryCallSettings<AddContextArtifactsAndExecutionsRequest,AddContextArtifactsAndExecutionsResponse>

addContextChildrenSettings()

public UnaryCallSettings<AddContextChildrenRequest,AddContextChildrenResponse> addContextChildrenSettings()

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

Returns
TypeDescription
UnaryCallSettings<AddContextChildrenRequest,AddContextChildrenResponse>

addExecutionEventsSettings()

public UnaryCallSettings<AddExecutionEventsRequest,AddExecutionEventsResponse> addExecutionEventsSettings()

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

Returns
TypeDescription
UnaryCallSettings<AddExecutionEventsRequest,AddExecutionEventsResponse>

createArtifactSettings()

public UnaryCallSettings<CreateArtifactRequest,Artifact> createArtifactSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateArtifactRequest,Artifact>

createContextSettings()

public UnaryCallSettings<CreateContextRequest,Context> createContextSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateContextRequest,Context>

createExecutionSettings()

public UnaryCallSettings<CreateExecutionRequest,Execution> createExecutionSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateExecutionRequest,Execution>

createMetadataSchemaSettings()

public UnaryCallSettings<CreateMetadataSchemaRequest,MetadataSchema> createMetadataSchemaSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateMetadataSchemaRequest,MetadataSchema>

createMetadataStoreOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateMetadataStoreRequest,MetadataStore,CreateMetadataStoreOperationMetadata>

createMetadataStoreSettings()

public UnaryCallSettings<CreateMetadataStoreRequest,Operation> createMetadataStoreSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateMetadataStoreRequest,Operation>

deleteArtifactOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteArtifactRequest,Empty,DeleteOperationMetadata>

deleteArtifactSettings()

public UnaryCallSettings<DeleteArtifactRequest,Operation> deleteArtifactSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteArtifactRequest,Operation>

deleteContextOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteContextRequest,Empty,DeleteOperationMetadata>

deleteContextSettings()

public UnaryCallSettings<DeleteContextRequest,Operation> deleteContextSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteContextRequest,Operation>

deleteExecutionOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteExecutionRequest,Empty,DeleteOperationMetadata>

deleteExecutionSettings()

public UnaryCallSettings<DeleteExecutionRequest,Operation> deleteExecutionSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteExecutionRequest,Operation>

deleteMetadataStoreOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteMetadataStoreRequest,Empty,DeleteMetadataStoreOperationMetadata>

deleteMetadataStoreSettings()

public UnaryCallSettings<DeleteMetadataStoreRequest,Operation> deleteMetadataStoreSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteMetadataStoreRequest,Operation>

getArtifactSettings()

public UnaryCallSettings<GetArtifactRequest,Artifact> getArtifactSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetArtifactRequest,Artifact>

getContextSettings()

public UnaryCallSettings<GetContextRequest,Context> getContextSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetContextRequest,Context>

getExecutionSettings()

public UnaryCallSettings<GetExecutionRequest,Execution> getExecutionSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetExecutionRequest,Execution>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

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

getMetadataSchemaSettings()

public UnaryCallSettings<GetMetadataSchemaRequest,MetadataSchema> getMetadataSchemaSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetMetadataSchemaRequest,MetadataSchema>

getMetadataStoreSettings()

public UnaryCallSettings<GetMetadataStoreRequest,MetadataStore> getMetadataStoreSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetMetadataStoreRequest,MetadataStore>

listArtifactsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListArtifactsRequest,ListArtifactsResponse,ListArtifactsPagedResponse>

listContextsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListContextsRequest,ListContextsResponse,ListContextsPagedResponse>

listExecutionsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListExecutionsRequest,ListExecutionsResponse,ListExecutionsPagedResponse>

listLocationsSettings()

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

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

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

listMetadataSchemasSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListMetadataSchemasRequest,ListMetadataSchemasResponse,ListMetadataSchemasPagedResponse>

listMetadataStoresSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListMetadataStoresRequest,ListMetadataStoresResponse,ListMetadataStoresPagedResponse>

purgeArtifactsOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<PurgeArtifactsRequest,PurgeArtifactsResponse,PurgeArtifactsMetadata>

purgeArtifactsSettings()

public UnaryCallSettings<PurgeArtifactsRequest,Operation> purgeArtifactsSettings()

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

Returns
TypeDescription
UnaryCallSettings<PurgeArtifactsRequest,Operation>

purgeContextsOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<PurgeContextsRequest,PurgeContextsResponse,PurgeContextsMetadata>

purgeContextsSettings()

public UnaryCallSettings<PurgeContextsRequest,Operation> purgeContextsSettings()

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

Returns
TypeDescription
UnaryCallSettings<PurgeContextsRequest,Operation>

purgeExecutionsOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<PurgeExecutionsRequest,PurgeExecutionsResponse,PurgeExecutionsMetadata>

purgeExecutionsSettings()

public UnaryCallSettings<PurgeExecutionsRequest,Operation> purgeExecutionsSettings()

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

Returns
TypeDescription
UnaryCallSettings<PurgeExecutionsRequest,Operation>

queryArtifactLineageSubgraphSettings()

public UnaryCallSettings<QueryArtifactLineageSubgraphRequest,LineageSubgraph> queryArtifactLineageSubgraphSettings()

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

Returns
TypeDescription
UnaryCallSettings<QueryArtifactLineageSubgraphRequest,LineageSubgraph>

queryContextLineageSubgraphSettings()

public UnaryCallSettings<QueryContextLineageSubgraphRequest,LineageSubgraph> queryContextLineageSubgraphSettings()

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

Returns
TypeDescription
UnaryCallSettings<QueryContextLineageSubgraphRequest,LineageSubgraph>

queryExecutionInputsAndOutputsSettings()

public UnaryCallSettings<QueryExecutionInputsAndOutputsRequest,LineageSubgraph> queryExecutionInputsAndOutputsSettings()

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

Returns
TypeDescription
UnaryCallSettings<QueryExecutionInputsAndOutputsRequest,LineageSubgraph>

removeContextChildrenSettings()

public UnaryCallSettings<RemoveContextChildrenRequest,RemoveContextChildrenResponse> removeContextChildrenSettings()

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

Returns
TypeDescription
UnaryCallSettings<RemoveContextChildrenRequest,RemoveContextChildrenResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public MetadataServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
MetadataServiceSettings.Builder
Overrides

updateArtifactSettings()

public UnaryCallSettings<UpdateArtifactRequest,Artifact> updateArtifactSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateArtifactRequest,Artifact>

updateContextSettings()

public UnaryCallSettings<UpdateContextRequest,Context> updateContextSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateContextRequest,Context>

updateExecutionSettings()

public UnaryCallSettings<UpdateExecutionRequest,Execution> updateExecutionSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateExecutionRequest,Execution>