Package com.google.cloud.aiplatform.v1
Class VertexRagDataServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<VertexRagDataServiceSettings>
com.google.cloud.aiplatform.v1.VertexRagDataServiceSettings
@Generated("by gapic-generator-java")
public class VertexRagDataServiceSettings
extends ClientSettings<VertexRagDataServiceSettings>
Settings class to configure an instance of
VertexRagDataServiceClient.
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
VertexRagDataServiceSettings.Builder vertexRagDataServiceSettingsBuilder =
VertexRagDataServiceSettings.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());
VertexRagDataServiceSettings 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
VertexRagDataServiceSettings.Builder vertexRagDataServiceSettingsBuilder =
VertexRagDataServiceSettings.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 VertexRagDataServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedVertexRagDataServiceSettings(VertexRagDataServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final VertexRagDataServiceSettingsReturns the object with the settings used for calls to createRagCorpus.Returns the object with the settings used for calls to createRagCorpus.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.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.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.Returns 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 getRagEngineConfig.Returns the object with the settings used for calls to getRagFile.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<ListRagFilesRequest,ListRagFilesResponse, VertexRagDataServiceClient.ListRagFilesPagedResponse> Returns the object with the settings used for calls to listRagFiles.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 uploadRagFile.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
VertexRagDataServiceSettings
protected VertexRagDataServiceSettings(VertexRagDataServiceSettings.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. -
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. -
create
public static final VertexRagDataServiceSettings create(VertexRagDataServiceStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default 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 classClientSettings<VertexRagDataServiceSettings>
-