Class VertexRagDataServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<VertexRagDataServiceStubSettings>
com.google.cloud.aiplatform.v1beta1.stub.VertexRagDataServiceStubSettings
@BetaApi
@Generated("by gapic-generator-java")
public class VertexRagDataServiceStubSettings
extends StubSettings<VertexRagDataServiceStubSettings>
Settings class to configure an instance of
VertexRagDataServiceStub.
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 getRagCorpus:
// 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
VertexRagDataServiceStubSettings.Builder vertexRagDataServiceSettingsBuilder =
VertexRagDataServiceStubSettings.newBuilder();
vertexRagDataServiceSettingsBuilder
.getRagCorpusSettings()
.setRetrySettings(
vertexRagDataServiceSettingsBuilder
.getRagCorpusSettings()
.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());
VertexRagDataServiceStubSettings vertexRagDataServiceSettings =
vertexRagDataServiceSettingsBuilder.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 createRagCorpus:
// 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
VertexRagDataServiceStubSettings.Builder vertexRagDataServiceSettingsBuilder =
VertexRagDataServiceStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
vertexRagDataServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for VertexRagDataServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedVertexRagDataServiceStubSettings(VertexRagDataServiceStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionOperationCallSettings<BatchCreateRagDataSchemasRequest,BatchCreateRagDataSchemasResponse, BatchCreateRagDataSchemasOperationMetadata> Returns the object with the settings used for calls to batchCreateRagDataSchemas.Returns the object with the settings used for calls to batchCreateRagDataSchemas.OperationCallSettings<BatchCreateRagMetadataRequest,BatchCreateRagMetadataResponse, BatchCreateRagMetadataOperationMetadata> Returns the object with the settings used for calls to batchCreateRagMetadata.Returns the object with the settings used for calls to batchCreateRagMetadata.OperationCallSettings<BatchDeleteRagDataSchemasRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to batchDeleteRagDataSchemas.Returns the object with the settings used for calls to batchDeleteRagDataSchemas.OperationCallSettings<BatchDeleteRagMetadataRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to batchDeleteRagMetadata.Returns the object with the settings used for calls to batchDeleteRagMetadata.Returns the object with the settings used for calls to createRagCorpus.Returns the object with the settings used for calls to createRagCorpus.Returns the object with the settings used for calls to createRagDataSchema.Returns the object with the settings used for calls to createRagMetadata.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<DeleteRagCorpusRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteRagCorpus.Returns the object with the settings used for calls to deleteRagCorpus.UnaryCallSettings<DeleteRagDataSchemaRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteRagDataSchema.OperationCallSettings<DeleteRagFileRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteRagFile.Returns the object with the settings used for calls to deleteRagFile.UnaryCallSettings<DeleteRagMetadataRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteRagMetadata.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 getIamPolicy.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getRagCorpus.Returns the object with the settings used for calls to getRagDataSchema.Returns the object with the settings used for calls to getRagEngineConfig.Returns the object with the settings used for calls to getRagFile.Returns the object with the settings used for calls to getRagMetadata.Returns the default service name.Returns the object with the settings used for calls to importRagFiles.Returns the object with the settings used for calls to importRagFiles.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, VertexRagDataServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListRagCorporaRequest,ListRagCorporaResponse, VertexRagDataServiceClient.ListRagCorporaPagedResponse> Returns the object with the settings used for calls to listRagCorpora.PagedCallSettings<ListRagDataSchemasRequest,ListRagDataSchemasResponse, VertexRagDataServiceClient.ListRagDataSchemasPagedResponse> Returns the object with the settings used for calls to listRagDataSchemas.PagedCallSettings<ListRagFilesRequest,ListRagFilesResponse, VertexRagDataServiceClient.ListRagFilesPagedResponse> Returns the object with the settings used for calls to listRagFiles.PagedCallSettings<ListRagMetadataRequest,ListRagMetadataResponse, VertexRagDataServiceClient.ListRagMetadataPagedResponse> Returns the object with the settings used for calls to listRagMetadata.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 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 updateRagCorpus.Returns the object with the settings used for calls to updateRagCorpus.OperationCallSettings<UpdateRagEngineConfigRequest,RagEngineConfig, UpdateRagEngineConfigOperationMetadata> Returns the object with the settings used for calls to updateRagEngineConfig.Returns the object with the settings used for calls to updateRagEngineConfig.Returns the object with the settings used for calls to updateRagMetadata.Returns the object with the settings used for calls to uploadRagFile.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
-
VertexRagDataServiceStubSettings
protected VertexRagDataServiceStubSettings(VertexRagDataServiceStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createRagCorpusSettings
Returns the object with the settings used for calls to createRagCorpus. -
createRagCorpusOperationSettings
public OperationCallSettings<CreateRagCorpusRequest,RagCorpus, createRagCorpusOperationSettings()CreateRagCorpusOperationMetadata> Returns the object with the settings used for calls to createRagCorpus. -
updateRagCorpusSettings
Returns the object with the settings used for calls to updateRagCorpus. -
updateRagCorpusOperationSettings
public OperationCallSettings<UpdateRagCorpusRequest,RagCorpus, updateRagCorpusOperationSettings()UpdateRagCorpusOperationMetadata> Returns the object with the settings used for calls to updateRagCorpus. -
getRagCorpusSettings
Returns the object with the settings used for calls to getRagCorpus. -
listRagCorporaSettings
public PagedCallSettings<ListRagCorporaRequest,ListRagCorporaResponse, listRagCorporaSettings()VertexRagDataServiceClient.ListRagCorporaPagedResponse> Returns the object with the settings used for calls to listRagCorpora. -
deleteRagCorpusSettings
Returns the object with the settings used for calls to deleteRagCorpus. -
deleteRagCorpusOperationSettings
public OperationCallSettings<DeleteRagCorpusRequest,com.google.protobuf.Empty, deleteRagCorpusOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteRagCorpus. -
uploadRagFileSettings
Returns the object with the settings used for calls to uploadRagFile. -
importRagFilesSettings
Returns the object with the settings used for calls to importRagFiles. -
importRagFilesOperationSettings
public OperationCallSettings<ImportRagFilesRequest,ImportRagFilesResponse, importRagFilesOperationSettings()ImportRagFilesOperationMetadata> Returns the object with the settings used for calls to importRagFiles. -
getRagFileSettings
Returns the object with the settings used for calls to getRagFile. -
listRagFilesSettings
public PagedCallSettings<ListRagFilesRequest,ListRagFilesResponse, listRagFilesSettings()VertexRagDataServiceClient.ListRagFilesPagedResponse> Returns the object with the settings used for calls to listRagFiles. -
deleteRagFileSettings
Returns the object with the settings used for calls to deleteRagFile. -
deleteRagFileOperationSettings
public OperationCallSettings<DeleteRagFileRequest,com.google.protobuf.Empty, deleteRagFileOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteRagFile. -
updateRagEngineConfigSettings
Returns the object with the settings used for calls to updateRagEngineConfig. -
updateRagEngineConfigOperationSettings
public OperationCallSettings<UpdateRagEngineConfigRequest,RagEngineConfig, updateRagEngineConfigOperationSettings()UpdateRagEngineConfigOperationMetadata> Returns the object with the settings used for calls to updateRagEngineConfig. -
getRagEngineConfigSettings
Returns the object with the settings used for calls to getRagEngineConfig. -
createRagDataSchemaSettings
Returns the object with the settings used for calls to createRagDataSchema. -
batchCreateRagDataSchemasSettings
public UnaryCallSettings<BatchCreateRagDataSchemasRequest,Operation> batchCreateRagDataSchemasSettings()Returns the object with the settings used for calls to batchCreateRagDataSchemas. -
batchCreateRagDataSchemasOperationSettings
public OperationCallSettings<BatchCreateRagDataSchemasRequest,BatchCreateRagDataSchemasResponse, batchCreateRagDataSchemasOperationSettings()BatchCreateRagDataSchemasOperationMetadata> Returns the object with the settings used for calls to batchCreateRagDataSchemas. -
getRagDataSchemaSettings
Returns the object with the settings used for calls to getRagDataSchema. -
listRagDataSchemasSettings
public PagedCallSettings<ListRagDataSchemasRequest,ListRagDataSchemasResponse, listRagDataSchemasSettings()VertexRagDataServiceClient.ListRagDataSchemasPagedResponse> Returns the object with the settings used for calls to listRagDataSchemas. -
deleteRagDataSchemaSettings
public UnaryCallSettings<DeleteRagDataSchemaRequest,com.google.protobuf.Empty> deleteRagDataSchemaSettings()Returns the object with the settings used for calls to deleteRagDataSchema. -
batchDeleteRagDataSchemasSettings
public UnaryCallSettings<BatchDeleteRagDataSchemasRequest,Operation> batchDeleteRagDataSchemasSettings()Returns the object with the settings used for calls to batchDeleteRagDataSchemas. -
batchDeleteRagDataSchemasOperationSettings
public OperationCallSettings<BatchDeleteRagDataSchemasRequest,com.google.protobuf.Empty, batchDeleteRagDataSchemasOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to batchDeleteRagDataSchemas. -
createRagMetadataSettings
Returns the object with the settings used for calls to createRagMetadata. -
batchCreateRagMetadataSettings
Returns the object with the settings used for calls to batchCreateRagMetadata. -
batchCreateRagMetadataOperationSettings
public OperationCallSettings<BatchCreateRagMetadataRequest,BatchCreateRagMetadataResponse, batchCreateRagMetadataOperationSettings()BatchCreateRagMetadataOperationMetadata> Returns the object with the settings used for calls to batchCreateRagMetadata. -
updateRagMetadataSettings
Returns the object with the settings used for calls to updateRagMetadata. -
getRagMetadataSettings
Returns the object with the settings used for calls to getRagMetadata. -
listRagMetadataSettings
public PagedCallSettings<ListRagMetadataRequest,ListRagMetadataResponse, listRagMetadataSettings()VertexRagDataServiceClient.ListRagMetadataPagedResponse> Returns the object with the settings used for calls to listRagMetadata. -
deleteRagMetadataSettings
public UnaryCallSettings<DeleteRagMetadataRequest,com.google.protobuf.Empty> deleteRagMetadataSettings()Returns the object with the settings used for calls to deleteRagMetadata. -
batchDeleteRagMetadataSettings
Returns the object with the settings used for calls to batchDeleteRagMetadata. -
batchDeleteRagMetadataOperationSettings
public OperationCallSettings<BatchDeleteRagMetadataRequest,com.google.protobuf.Empty, batchDeleteRagMetadataOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to batchDeleteRagMetadata. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()VertexRagDataServiceClient.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<VertexRagDataServiceStubSettings>
-
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<VertexRagDataServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<VertexRagDataServiceStubSettings>
-