Class MetadataServiceStubSettings (3.53.0)

Version 3.53.0

• 3.54.0 (latest)
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public class MetadataServiceStubSettings extends StubSettings<MetadataServiceStubSettings>

Settings class to configure an instance of MetadataServiceStub.

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 RetrySettings of getMetadataStore:

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

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

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createMetadataStore:

 // 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
 MetadataServiceStubSettings.Builder metadataServiceSettingsBuilder =
     MetadataServiceStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 metadataServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > StubSettings > MetadataServiceStubSettings

Inherited Members

StubSettings.getApiKey()

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogCheckIntervalDuration()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

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

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

Obsolete

Use getEndpoint() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 MetadataServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
MetadataServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static MetadataServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
MetadataServiceStubSettings.Builder

Constructors

MetadataServiceStubSettings(MetadataServiceStubSettings.Builder settingsBuilder)

protected MetadataServiceStubSettings(MetadataServiceStubSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	MetadataServiceStubSettings.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>

createStub()

public MetadataServiceStub createStub()

Returns
Type	Description
MetadataServiceStub

Exceptions
Type	Description
IOException

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>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
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
Type	Description
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
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>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
String

Overrides

StubSettings<SettingsT>.getServiceName()

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>

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>

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>

removeContextChildrenSettings()

public UnaryCallSettings<RemoveContextChildrenRequest,RemoveContextChildrenResponse> removeContextChildrenSettings()

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

Returns
Type	Description
UnaryCallSettings<RemoveContextChildrenRequest,RemoveContextChildrenResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
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
Type	Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public MetadataServiceStubSettings.Builder toBuilder()

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

Returns
Type	Description
MetadataServiceStubSettings.Builder

Overrides

StubSettings<SettingsT>.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>