Class MetadataServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<MetadataServiceStubSettings>
com.google.cloud.aiplatform.v1beta1.stub.MetadataServiceStubSettings
@BetaApi
@Generated("by gapic-generator-java")
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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](https://docs.cloud.google.com/java/docs/client-retries) 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)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
metadataServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for MetadataServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedMetadataServiceStubSettings(MetadataServiceStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to addContextArtifactsAndExecutions.Returns the object with the settings used for calls to addContextChildren.Returns the object with the settings used for calls to addExecutionEvents.Returns the object with the settings used for calls to createArtifact.Returns the object with the settings used for calls to createContext.Returns the object with the settings used for calls to createExecution.Returns the object with the settings used for calls to createMetadataSchema.OperationCallSettings<CreateMetadataStoreRequest,MetadataStore, CreateMetadataStoreOperationMetadata> Returns the object with the settings used for calls to createMetadataStore.Returns the object with the settings used for calls to createMetadataStore.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteArtifactRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteArtifact.Returns the object with the settings used for calls to deleteArtifact.OperationCallSettings<DeleteContextRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteContext.Returns the object with the settings used for calls to deleteContext.OperationCallSettings<DeleteExecutionRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteExecution.Returns the object with the settings used for calls to deleteExecution.OperationCallSettings<DeleteMetadataStoreRequest,com.google.protobuf.Empty, DeleteMetadataStoreOperationMetadata> Returns the object with the settings used for calls to deleteMetadataStore.Returns the object with the settings used for calls to deleteMetadataStore.Returns the object with the settings used for calls to getArtifact.Returns the object with the settings used for calls to getContext.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getExecution.Returns the object with the settings used for calls to getIamPolicy.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getMetadataSchema.Returns the object with the settings used for calls to getMetadataStore.Returns the default service name.PagedCallSettings<ListArtifactsRequest,ListArtifactsResponse, MetadataServiceClient.ListArtifactsPagedResponse> Returns the object with the settings used for calls to listArtifacts.PagedCallSettings<ListContextsRequest,ListContextsResponse, MetadataServiceClient.ListContextsPagedResponse> Returns the object with the settings used for calls to listContexts.PagedCallSettings<ListExecutionsRequest,ListExecutionsResponse, MetadataServiceClient.ListExecutionsPagedResponse> Returns the object with the settings used for calls to listExecutions.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, MetadataServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListMetadataSchemasRequest,ListMetadataSchemasResponse, MetadataServiceClient.ListMetadataSchemasPagedResponse> Returns the object with the settings used for calls to listMetadataSchemas.PagedCallSettings<ListMetadataStoresRequest,ListMetadataStoresResponse, MetadataServiceClient.ListMetadataStoresPagedResponse> Returns the object with the settings used for calls to listMetadataStores.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to purgeArtifacts.Returns the object with the settings used for calls to purgeArtifacts.Returns the object with the settings used for calls to purgeContexts.Returns the object with the settings used for calls to purgeContexts.Returns the object with the settings used for calls to purgeExecutions.Returns the object with the settings used for calls to purgeExecutions.Returns the object with the settings used for calls to queryArtifactLineageSubgraph.Returns the object with the settings used for calls to queryContextLineageSubgraph.Returns the object with the settings used for calls to queryExecutionInputsAndOutputs.Returns the object with the settings used for calls to removeContextChildren.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateArtifact.Returns the object with the settings used for calls to updateContext.Returns the object with the settings used for calls to updateExecution.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
MetadataServiceStubSettings
protected MetadataServiceStubSettings(MetadataServiceStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createMetadataStoreSettings
Returns the object with the settings used for calls to createMetadataStore. -
createMetadataStoreOperationSettings
public OperationCallSettings<CreateMetadataStoreRequest,MetadataStore, createMetadataStoreOperationSettings()CreateMetadataStoreOperationMetadata> Returns the object with the settings used for calls to createMetadataStore. -
getMetadataStoreSettings
Returns the object with the settings used for calls to getMetadataStore. -
listMetadataStoresSettings
public PagedCallSettings<ListMetadataStoresRequest,ListMetadataStoresResponse, listMetadataStoresSettings()MetadataServiceClient.ListMetadataStoresPagedResponse> Returns the object with the settings used for calls to listMetadataStores. -
deleteMetadataStoreSettings
Returns the object with the settings used for calls to deleteMetadataStore. -
deleteMetadataStoreOperationSettings
public OperationCallSettings<DeleteMetadataStoreRequest,com.google.protobuf.Empty, deleteMetadataStoreOperationSettings()DeleteMetadataStoreOperationMetadata> Returns the object with the settings used for calls to deleteMetadataStore. -
createArtifactSettings
Returns the object with the settings used for calls to createArtifact. -
getArtifactSettings
Returns the object with the settings used for calls to getArtifact. -
listArtifactsSettings
public PagedCallSettings<ListArtifactsRequest,ListArtifactsResponse, listArtifactsSettings()MetadataServiceClient.ListArtifactsPagedResponse> Returns the object with the settings used for calls to listArtifacts. -
updateArtifactSettings
Returns the object with the settings used for calls to updateArtifact. -
deleteArtifactSettings
Returns the object with the settings used for calls to deleteArtifact. -
deleteArtifactOperationSettings
public OperationCallSettings<DeleteArtifactRequest,com.google.protobuf.Empty, deleteArtifactOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteArtifact. -
purgeArtifactsSettings
Returns the object with the settings used for calls to purgeArtifacts. -
purgeArtifactsOperationSettings
public OperationCallSettings<PurgeArtifactsRequest,PurgeArtifactsResponse, purgeArtifactsOperationSettings()PurgeArtifactsMetadata> Returns the object with the settings used for calls to purgeArtifacts. -
createContextSettings
Returns the object with the settings used for calls to createContext. -
getContextSettings
Returns the object with the settings used for calls to getContext. -
listContextsSettings
public PagedCallSettings<ListContextsRequest,ListContextsResponse, listContextsSettings()MetadataServiceClient.ListContextsPagedResponse> Returns the object with the settings used for calls to listContexts. -
updateContextSettings
Returns the object with the settings used for calls to updateContext. -
deleteContextSettings
Returns the object with the settings used for calls to deleteContext. -
deleteContextOperationSettings
public OperationCallSettings<DeleteContextRequest,com.google.protobuf.Empty, deleteContextOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteContext. -
purgeContextsSettings
Returns the object with the settings used for calls to purgeContexts. -
purgeContextsOperationSettings
public OperationCallSettings<PurgeContextsRequest,PurgeContextsResponse, purgeContextsOperationSettings()PurgeContextsMetadata> Returns the object with the settings used for calls to purgeContexts. -
addContextArtifactsAndExecutionsSettings
public UnaryCallSettings<AddContextArtifactsAndExecutionsRequest,AddContextArtifactsAndExecutionsResponse> addContextArtifactsAndExecutionsSettings()Returns the object with the settings used for calls to addContextArtifactsAndExecutions. -
addContextChildrenSettings
public UnaryCallSettings<AddContextChildrenRequest,AddContextChildrenResponse> addContextChildrenSettings()Returns the object with the settings used for calls to addContextChildren. -
removeContextChildrenSettings
public UnaryCallSettings<RemoveContextChildrenRequest,RemoveContextChildrenResponse> removeContextChildrenSettings()Returns the object with the settings used for calls to removeContextChildren. -
queryContextLineageSubgraphSettings
public UnaryCallSettings<QueryContextLineageSubgraphRequest,LineageSubgraph> queryContextLineageSubgraphSettings()Returns the object with the settings used for calls to queryContextLineageSubgraph. -
createExecutionSettings
Returns the object with the settings used for calls to createExecution. -
getExecutionSettings
Returns the object with the settings used for calls to getExecution. -
listExecutionsSettings
public PagedCallSettings<ListExecutionsRequest,ListExecutionsResponse, listExecutionsSettings()MetadataServiceClient.ListExecutionsPagedResponse> Returns the object with the settings used for calls to listExecutions. -
updateExecutionSettings
Returns the object with the settings used for calls to updateExecution. -
deleteExecutionSettings
Returns the object with the settings used for calls to deleteExecution. -
deleteExecutionOperationSettings
public OperationCallSettings<DeleteExecutionRequest,com.google.protobuf.Empty, deleteExecutionOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteExecution. -
purgeExecutionsSettings
Returns the object with the settings used for calls to purgeExecutions. -
purgeExecutionsOperationSettings
public OperationCallSettings<PurgeExecutionsRequest,PurgeExecutionsResponse, purgeExecutionsOperationSettings()PurgeExecutionsMetadata> Returns the object with the settings used for calls to purgeExecutions. -
addExecutionEventsSettings
public UnaryCallSettings<AddExecutionEventsRequest,AddExecutionEventsResponse> addExecutionEventsSettings()Returns the object with the settings used for calls to addExecutionEvents. -
queryExecutionInputsAndOutputsSettings
public UnaryCallSettings<QueryExecutionInputsAndOutputsRequest,LineageSubgraph> queryExecutionInputsAndOutputsSettings()Returns the object with the settings used for calls to queryExecutionInputsAndOutputs. -
createMetadataSchemaSettings
Returns the object with the settings used for calls to createMetadataSchema. -
getMetadataSchemaSettings
Returns the object with the settings used for calls to getMetadataSchema. -
listMetadataSchemasSettings
public PagedCallSettings<ListMetadataSchemasRequest,ListMetadataSchemasResponse, listMetadataSchemasSettings()MetadataServiceClient.ListMetadataSchemasPagedResponse> Returns the object with the settings used for calls to listMetadataSchemas. -
queryArtifactLineageSubgraphSettings
public UnaryCallSettings<QueryArtifactLineageSubgraphRequest,LineageSubgraph> queryArtifactLineageSubgraphSettings()Returns the object with the settings used for calls to queryArtifactLineageSubgraph. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()MetadataServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<MetadataServiceStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<MetadataServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<MetadataServiceStubSettings>
-