com.google.cloud.aiplatform.v1beta1

Class VertexRagDataServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<VertexRagDataServiceSettings>

com.google.cloud.aiplatform.v1beta1.VertexRagDataServiceSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class VertexRagDataServiceSettings
extends com.google.api.gax.rpc.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://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) 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 Classes

Modifier and Type	Class and Description
static class	VertexRagDataServiceSettings.Builder Builder for VertexRagDataServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VertexRagDataServiceSettings(VertexRagDataServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static VertexRagDataServiceSettings	create(VertexRagDataServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateRagCorpusRequest,RagCorpus,CreateRagCorpusOperationMetadata>	createRagCorpusOperationSettings() Returns the object with the settings used for calls to createRagCorpus.
com.google.api.gax.rpc.UnaryCallSettings<CreateRagCorpusRequest,com.google.longrunning.Operation>	createRagCorpusSettings() Returns the object with the settings used for calls to createRagCorpus.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteRagCorpusRequest,com.google.protobuf.Empty,DeleteOperationMetadata>	deleteRagCorpusOperationSettings() Returns the object with the settings used for calls to deleteRagCorpus.
com.google.api.gax.rpc.UnaryCallSettings<DeleteRagCorpusRequest,com.google.longrunning.Operation>	deleteRagCorpusSettings() Returns the object with the settings used for calls to deleteRagCorpus.
com.google.api.gax.rpc.OperationCallSettings<DeleteRagFileRequest,com.google.protobuf.Empty,DeleteOperationMetadata>	deleteRagFileOperationSettings() Returns the object with the settings used for calls to deleteRagFile.
com.google.api.gax.rpc.UnaryCallSettings<DeleteRagFileRequest,com.google.longrunning.Operation>	deleteRagFileSettings() Returns the object with the settings used for calls to deleteRagFile.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationSettings() Returns the object with the settings used for calls to getLocation.
com.google.api.gax.rpc.UnaryCallSettings<GetRagCorpusRequest,RagCorpus>	getRagCorpusSettings() Returns the object with the settings used for calls to getRagCorpus.
com.google.api.gax.rpc.UnaryCallSettings<GetRagEngineConfigRequest,RagEngineConfig>	getRagEngineConfigSettings() Returns the object with the settings used for calls to getRagEngineConfig.
com.google.api.gax.rpc.UnaryCallSettings<GetRagFileRequest,RagFile>	getRagFileSettings() Returns the object with the settings used for calls to getRagFile.
com.google.api.gax.rpc.OperationCallSettings<ImportRagFilesRequest,ImportRagFilesResponse,ImportRagFilesOperationMetadata>	importRagFilesOperationSettings() Returns the object with the settings used for calls to importRagFiles.
com.google.api.gax.rpc.UnaryCallSettings<ImportRagFilesRequest,com.google.longrunning.Operation>	importRagFilesSettings() Returns the object with the settings used for calls to importRagFiles.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,VertexRagDataServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
com.google.api.gax.rpc.PagedCallSettings<ListRagCorporaRequest,ListRagCorporaResponse,VertexRagDataServiceClient.ListRagCorporaPagedResponse>	listRagCorporaSettings() Returns the object with the settings used for calls to listRagCorpora.
com.google.api.gax.rpc.PagedCallSettings<ListRagFilesRequest,ListRagFilesResponse,VertexRagDataServiceClient.ListRagFilesPagedResponse>	listRagFilesSettings() Returns the object with the settings used for calls to listRagFiles.
static VertexRagDataServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static VertexRagDataServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
VertexRagDataServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateRagCorpusRequest,RagCorpus,UpdateRagCorpusOperationMetadata>	updateRagCorpusOperationSettings() Returns the object with the settings used for calls to updateRagCorpus.
com.google.api.gax.rpc.UnaryCallSettings<UpdateRagCorpusRequest,com.google.longrunning.Operation>	updateRagCorpusSettings() Returns the object with the settings used for calls to updateRagCorpus.
com.google.api.gax.rpc.OperationCallSettings<UpdateRagEngineConfigRequest,RagEngineConfig,UpdateRagEngineConfigOperationMetadata>	updateRagEngineConfigOperationSettings() Returns the object with the settings used for calls to updateRagEngineConfig.
com.google.api.gax.rpc.UnaryCallSettings<UpdateRagEngineConfigRequest,com.google.longrunning.Operation>	updateRagEngineConfigSettings() Returns the object with the settings used for calls to updateRagEngineConfig.
com.google.api.gax.rpc.UnaryCallSettings<UploadRagFileRequest,UploadRagFileResponse>	uploadRagFileSettings() 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VertexRagDataServiceSettings

protected VertexRagDataServiceSettings(VertexRagDataServiceSettings.Builder settingsBuilder)
                                throws IOException

Throws:

IOException

Method Detail

createRagCorpusSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateRagCorpusRequest,com.google.longrunning.Operation> createRagCorpusSettings()

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

createRagCorpusOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateRagCorpusRequest,RagCorpus,CreateRagCorpusOperationMetadata> createRagCorpusOperationSettings()

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

updateRagCorpusSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateRagCorpusRequest,com.google.longrunning.Operation> updateRagCorpusSettings()

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

updateRagCorpusOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateRagCorpusRequest,RagCorpus,UpdateRagCorpusOperationMetadata> updateRagCorpusOperationSettings()

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

getRagCorpusSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetRagCorpusRequest,RagCorpus> getRagCorpusSettings()

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

listRagCorporaSettings

public com.google.api.gax.rpc.PagedCallSettings<ListRagCorporaRequest,ListRagCorporaResponse,VertexRagDataServiceClient.ListRagCorporaPagedResponse> listRagCorporaSettings()

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

deleteRagCorpusSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteRagCorpusRequest,com.google.longrunning.Operation> deleteRagCorpusSettings()

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

deleteRagCorpusOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteRagCorpusRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteRagCorpusOperationSettings()

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

uploadRagFileSettings

public com.google.api.gax.rpc.UnaryCallSettings<UploadRagFileRequest,UploadRagFileResponse> uploadRagFileSettings()

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

importRagFilesSettings

public com.google.api.gax.rpc.UnaryCallSettings<ImportRagFilesRequest,com.google.longrunning.Operation> importRagFilesSettings()

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

importRagFilesOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ImportRagFilesRequest,ImportRagFilesResponse,ImportRagFilesOperationMetadata> importRagFilesOperationSettings()

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

getRagFileSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetRagFileRequest,RagFile> getRagFileSettings()

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

listRagFilesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListRagFilesRequest,ListRagFilesResponse,VertexRagDataServiceClient.ListRagFilesPagedResponse> listRagFilesSettings()

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

deleteRagFileSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteRagFileRequest,com.google.longrunning.Operation> deleteRagFileSettings()

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

deleteRagFileOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteRagFileRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteRagFileOperationSettings()

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

updateRagEngineConfigSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateRagEngineConfigRequest,com.google.longrunning.Operation> updateRagEngineConfigSettings()

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

updateRagEngineConfigOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateRagEngineConfigRequest,RagEngineConfig,UpdateRagEngineConfigOperationMetadata> updateRagEngineConfigOperationSettings()

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

getRagEngineConfigSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetRagEngineConfigRequest,RagEngineConfig> getRagEngineConfigSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,VertexRagDataServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

getLocationSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()

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

setIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

getIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

testIamPermissionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.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

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static VertexRagDataServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static VertexRagDataServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public VertexRagDataServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<VertexRagDataServiceSettings>