Class VertexRagDataServiceClient (3.89.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: A service for managing user data for RAG.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagCorpusName name = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]");
   RagCorpus response = vertexRagDataServiceClient.getRagCorpus(name);
 }

Note: close() needs to be called on the VertexRagDataServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

CreateRagCorpus

Creates a RagCorpus.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createRagCorpusAsync(CreateRagCorpusRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createRagCorpusAsync(LocationName parent, RagCorpus ragCorpus)

  • createRagCorpusAsync(String parent, RagCorpus ragCorpus)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createRagCorpusOperationCallable()

  • createRagCorpusCallable()

UpdateRagCorpus

Updates a RagCorpus.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateRagCorpusAsync(UpdateRagCorpusRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateRagCorpusAsync(RagCorpus ragCorpus)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateRagCorpusOperationCallable()

  • updateRagCorpusCallable()

GetRagCorpus

Gets a RagCorpus.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getRagCorpus(GetRagCorpusRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getRagCorpus(RagCorpusName name)

  • getRagCorpus(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getRagCorpusCallable()

ListRagCorpora

Lists RagCorpora in a Location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listRagCorpora(ListRagCorporaRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listRagCorpora(LocationName parent)

  • listRagCorpora(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listRagCorporaPagedCallable()

  • listRagCorporaCallable()

DeleteRagCorpus

Deletes a RagCorpus.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteRagCorpusAsync(DeleteRagCorpusRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteRagCorpusAsync(RagCorpusName name)

  • deleteRagCorpusAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteRagCorpusOperationCallable()

  • deleteRagCorpusCallable()

UploadRagFile

Upload a file into a RagCorpus.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • uploadRagFile(UploadRagFileRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • uploadRagFile(RagCorpusName parent, RagFile ragFile, UploadRagFileConfig uploadRagFileConfig)

  • uploadRagFile(String parent, RagFile ragFile, UploadRagFileConfig uploadRagFileConfig)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • uploadRagFileCallable()

ImportRagFiles

Import files from Google Cloud Storage or Google Drive into a RagCorpus.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • importRagFilesAsync(ImportRagFilesRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • importRagFilesAsync(RagCorpusName parent, ImportRagFilesConfig importRagFilesConfig)

  • importRagFilesAsync(String parent, ImportRagFilesConfig importRagFilesConfig)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • importRagFilesOperationCallable()

  • importRagFilesCallable()

GetRagFile

Gets a RagFile.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getRagFile(GetRagFileRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getRagFile(RagFileName name)

  • getRagFile(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getRagFileCallable()

ListRagFiles

Lists RagFiles in a RagCorpus.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listRagFiles(ListRagFilesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listRagFiles(RagCorpusName parent)

  • listRagFiles(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listRagFilesPagedCallable()

  • listRagFilesCallable()

DeleteRagFile

Deletes a RagFile.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteRagFileAsync(DeleteRagFileRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteRagFileAsync(RagFileName name)

  • deleteRagFileAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteRagFileOperationCallable()

  • deleteRagFileCallable()

UpdateRagEngineConfig

Updates a RagEngineConfig.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateRagEngineConfigAsync(UpdateRagEngineConfigRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateRagEngineConfigAsync(RagEngineConfig ragEngineConfig)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateRagEngineConfigOperationCallable()

  • updateRagEngineConfigCallable()

GetRagEngineConfig

Gets a RagEngineConfig.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getRagEngineConfig(GetRagEngineConfigRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getRagEngineConfig(RagEngineConfigName name)

  • getRagEngineConfig(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getRagEngineConfigCallable()

CreateRagDataSchema

Creates a RagDataSchema.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createRagDataSchema(CreateRagDataSchemaRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createRagDataSchema(RagCorpusName parent, RagDataSchema ragDataSchema, String ragDataSchemaId)

  • createRagDataSchema(String parent, RagDataSchema ragDataSchema, String ragDataSchemaId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createRagDataSchemaCallable()

BatchCreateRagDataSchemas

Batch Create one or more RagDataSchemas

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchCreateRagDataSchemasAsync(BatchCreateRagDataSchemasRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchCreateRagDataSchemasOperationCallable()

  • batchCreateRagDataSchemasCallable()

GetRagDataSchema

Gets a RagDataSchema.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getRagDataSchema(GetRagDataSchemaRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getRagDataSchema(RagDataSchemaName name)

  • getRagDataSchema(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getRagDataSchemaCallable()

ListRagDataSchemas

Lists RagDataSchemas in a Location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listRagDataSchemas(ListRagDataSchemasRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listRagDataSchemas(RagCorpusName parent)

  • listRagDataSchemas(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listRagDataSchemasPagedCallable()

  • listRagDataSchemasCallable()

DeleteRagDataSchema

Deletes a RagDataSchema.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteRagDataSchema(DeleteRagDataSchemaRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteRagDataSchema(RagDataSchemaName name)

  • deleteRagDataSchema(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteRagDataSchemaCallable()

BatchDeleteRagDataSchemas

Batch Deletes one or more RagDataSchemas

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchDeleteRagDataSchemasAsync(BatchDeleteRagDataSchemasRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchDeleteRagDataSchemasOperationCallable()

  • batchDeleteRagDataSchemasCallable()

CreateRagMetadata

Creates a RagMetadata.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createRagMetadata(CreateRagMetadataRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createRagMetadata(RagFileName parent, RagMetadata ragMetadata, String ragMetadataId)

  • createRagMetadata(String parent, RagMetadata ragMetadata, String ragMetadataId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createRagMetadataCallable()

BatchCreateRagMetadata

Batch Create one or more RagMetadatas

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchCreateRagMetadataAsync(BatchCreateRagMetadataRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchCreateRagMetadataOperationCallable()

  • batchCreateRagMetadataCallable()

UpdateRagMetadata

Updates a RagMetadata.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateRagMetadata(UpdateRagMetadataRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateRagMetadata(RagMetadata ragMetadata)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateRagMetadataCallable()

GetRagMetadata

Gets a RagMetadata.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getRagMetadata(GetRagMetadataRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getRagMetadata(RagMetadataName name)

  • getRagMetadata(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getRagMetadataCallable()

ListRagMetadata

Lists RagMetadata in a RagFile.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listRagMetadata(ListRagMetadataRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listRagMetadata(RagFileName parent)

  • listRagMetadata(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listRagMetadataPagedCallable()

  • listRagMetadataCallable()

DeleteRagMetadata

Deletes a RagMetadata.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteRagMetadata(DeleteRagMetadataRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteRagMetadata(RagMetadataName name)

  • deleteRagMetadata(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteRagMetadataCallable()

BatchDeleteRagMetadata

Batch Deletes one or more RagMetadata.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchDeleteRagMetadataAsync(BatchDeleteRagMetadataRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchDeleteRagMetadataOperationCallable()

  • batchDeleteRagMetadataCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setIamPolicy(SetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setIamPolicyCallable()

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIamPolicy(GetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIamPolicyCallable()

TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • testIamPermissions(TestIamPermissionsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testIamPermissionsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of VertexRagDataServiceSettings to create(). For example:

To customize credentials:


 // 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 vertexRagDataServiceSettings =
     VertexRagDataServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create(vertexRagDataServiceSettings);

To customize the endpoint:


 // 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 vertexRagDataServiceSettings =
     VertexRagDataServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create(vertexRagDataServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > VertexRagDataServiceClient

Static Methods

create()

public static final VertexRagDataServiceClient create()

Constructs an instance of VertexRagDataServiceClient with default settings.

Returns
Type Description
VertexRagDataServiceClient
Exceptions
Type Description
IOException

create(VertexRagDataServiceSettings settings)

public static final VertexRagDataServiceClient create(VertexRagDataServiceSettings settings)

Constructs an instance of VertexRagDataServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings VertexRagDataServiceSettings
Returns
Type Description
VertexRagDataServiceClient
Exceptions
Type Description
IOException

create(VertexRagDataServiceStub stub)

public static final VertexRagDataServiceClient create(VertexRagDataServiceStub stub)

Constructs an instance of VertexRagDataServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(VertexRagDataServiceSettings).

Parameter
Name Description
stub VertexRagDataServiceStub
Returns
Type Description
VertexRagDataServiceClient

Constructors

VertexRagDataServiceClient(VertexRagDataServiceSettings settings)

protected VertexRagDataServiceClient(VertexRagDataServiceSettings settings)

Constructs an instance of VertexRagDataServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings VertexRagDataServiceSettings

VertexRagDataServiceClient(VertexRagDataServiceStub stub)

protected VertexRagDataServiceClient(VertexRagDataServiceStub stub)
Parameter
Name Description
stub VertexRagDataServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

batchCreateRagDataSchemasAsync(BatchCreateRagDataSchemasRequest request)

public final OperationFuture<BatchCreateRagDataSchemasResponse,BatchCreateRagDataSchemasOperationMetadata> batchCreateRagDataSchemasAsync(BatchCreateRagDataSchemasRequest request)

Batch Create one or more RagDataSchemas

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   BatchCreateRagDataSchemasRequest request =
       BatchCreateRagDataSchemasRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .addAllRequests(new ArrayList<CreateRagDataSchemaRequest>())
           .build();
   BatchCreateRagDataSchemasResponse response =
       vertexRagDataServiceClient.batchCreateRagDataSchemasAsync(request).get();
 }
Parameter
Name Description
request BatchCreateRagDataSchemasRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<BatchCreateRagDataSchemasResponse,BatchCreateRagDataSchemasOperationMetadata>

batchCreateRagDataSchemasCallable()

public final UnaryCallable<BatchCreateRagDataSchemasRequest,Operation> batchCreateRagDataSchemasCallable()

Batch Create one or more RagDataSchemas

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   BatchCreateRagDataSchemasRequest request =
       BatchCreateRagDataSchemasRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .addAllRequests(new ArrayList<CreateRagDataSchemaRequest>())
           .build();
   ApiFuture<Operation> future =
       vertexRagDataServiceClient.batchCreateRagDataSchemasCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<BatchCreateRagDataSchemasRequest,Operation>

batchCreateRagDataSchemasOperationCallable()

public final OperationCallable<BatchCreateRagDataSchemasRequest,BatchCreateRagDataSchemasResponse,BatchCreateRagDataSchemasOperationMetadata> batchCreateRagDataSchemasOperationCallable()

Batch Create one or more RagDataSchemas

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   BatchCreateRagDataSchemasRequest request =
       BatchCreateRagDataSchemasRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .addAllRequests(new ArrayList<CreateRagDataSchemaRequest>())
           .build();
   OperationFuture<BatchCreateRagDataSchemasResponse, BatchCreateRagDataSchemasOperationMetadata>
       future =
           vertexRagDataServiceClient
               .batchCreateRagDataSchemasOperationCallable()
               .futureCall(request);
   // Do something.
   BatchCreateRagDataSchemasResponse response = future.get();
 }
Returns
Type Description
OperationCallable<BatchCreateRagDataSchemasRequest,BatchCreateRagDataSchemasResponse,BatchCreateRagDataSchemasOperationMetadata>

batchCreateRagMetadataAsync(BatchCreateRagMetadataRequest request)

public final OperationFuture<BatchCreateRagMetadataResponse,BatchCreateRagMetadataOperationMetadata> batchCreateRagMetadataAsync(BatchCreateRagMetadataRequest request)

Batch Create one or more RagMetadatas

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   BatchCreateRagMetadataRequest request =
       BatchCreateRagMetadataRequest.newBuilder()
           .setParent(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .addAllRequests(new ArrayList<CreateRagMetadataRequest>())
           .build();
   BatchCreateRagMetadataResponse response =
       vertexRagDataServiceClient.batchCreateRagMetadataAsync(request).get();
 }
Parameter
Name Description
request BatchCreateRagMetadataRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<BatchCreateRagMetadataResponse,BatchCreateRagMetadataOperationMetadata>

batchCreateRagMetadataCallable()

public final UnaryCallable<BatchCreateRagMetadataRequest,Operation> batchCreateRagMetadataCallable()

Batch Create one or more RagMetadatas

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   BatchCreateRagMetadataRequest request =
       BatchCreateRagMetadataRequest.newBuilder()
           .setParent(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .addAllRequests(new ArrayList<CreateRagMetadataRequest>())
           .build();
   ApiFuture<Operation> future =
       vertexRagDataServiceClient.batchCreateRagMetadataCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<BatchCreateRagMetadataRequest,Operation>

batchCreateRagMetadataOperationCallable()

public final OperationCallable<BatchCreateRagMetadataRequest,BatchCreateRagMetadataResponse,BatchCreateRagMetadataOperationMetadata> batchCreateRagMetadataOperationCallable()

Batch Create one or more RagMetadatas

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   BatchCreateRagMetadataRequest request =
       BatchCreateRagMetadataRequest.newBuilder()
           .setParent(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .addAllRequests(new ArrayList<CreateRagMetadataRequest>())
           .build();
   OperationFuture<BatchCreateRagMetadataResponse, BatchCreateRagMetadataOperationMetadata>
       future =
           vertexRagDataServiceClient
               .batchCreateRagMetadataOperationCallable()
               .futureCall(request);
   // Do something.
   BatchCreateRagMetadataResponse response = future.get();
 }
Returns
Type Description
OperationCallable<BatchCreateRagMetadataRequest,BatchCreateRagMetadataResponse,BatchCreateRagMetadataOperationMetadata>

batchDeleteRagDataSchemasAsync(BatchDeleteRagDataSchemasRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> batchDeleteRagDataSchemasAsync(BatchDeleteRagDataSchemasRequest request)

Batch Deletes one or more RagDataSchemas

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   BatchDeleteRagDataSchemasRequest request =
       BatchDeleteRagDataSchemasRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   vertexRagDataServiceClient.batchDeleteRagDataSchemasAsync(request).get();
 }
Parameter
Name Description
request BatchDeleteRagDataSchemasRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

batchDeleteRagDataSchemasCallable()

public final UnaryCallable<BatchDeleteRagDataSchemasRequest,Operation> batchDeleteRagDataSchemasCallable()

Batch Deletes one or more RagDataSchemas

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   BatchDeleteRagDataSchemasRequest request =
       BatchDeleteRagDataSchemasRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   ApiFuture<Operation> future =
       vertexRagDataServiceClient.batchDeleteRagDataSchemasCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<BatchDeleteRagDataSchemasRequest,Operation>

batchDeleteRagDataSchemasOperationCallable()

public final OperationCallable<BatchDeleteRagDataSchemasRequest,Empty,DeleteOperationMetadata> batchDeleteRagDataSchemasOperationCallable()

Batch Deletes one or more RagDataSchemas

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   BatchDeleteRagDataSchemasRequest request =
       BatchDeleteRagDataSchemasRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       vertexRagDataServiceClient
           .batchDeleteRagDataSchemasOperationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<BatchDeleteRagDataSchemasRequest,Empty,DeleteOperationMetadata>

batchDeleteRagMetadataAsync(BatchDeleteRagMetadataRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> batchDeleteRagMetadataAsync(BatchDeleteRagMetadataRequest request)

Batch Deletes one or more RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   BatchDeleteRagMetadataRequest request =
       BatchDeleteRagMetadataRequest.newBuilder()
           .setParent(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .addAllNames(new ArrayList<String>())
           .build();
   vertexRagDataServiceClient.batchDeleteRagMetadataAsync(request).get();
 }
Parameter
Name Description
request BatchDeleteRagMetadataRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

batchDeleteRagMetadataCallable()

public final UnaryCallable<BatchDeleteRagMetadataRequest,Operation> batchDeleteRagMetadataCallable()

Batch Deletes one or more RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   BatchDeleteRagMetadataRequest request =
       BatchDeleteRagMetadataRequest.newBuilder()
           .setParent(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .addAllNames(new ArrayList<String>())
           .build();
   ApiFuture<Operation> future =
       vertexRagDataServiceClient.batchDeleteRagMetadataCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<BatchDeleteRagMetadataRequest,Operation>

batchDeleteRagMetadataOperationCallable()

public final OperationCallable<BatchDeleteRagMetadataRequest,Empty,DeleteOperationMetadata> batchDeleteRagMetadataOperationCallable()

Batch Deletes one or more RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   BatchDeleteRagMetadataRequest request =
       BatchDeleteRagMetadataRequest.newBuilder()
           .setParent(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .addAllNames(new ArrayList<String>())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       vertexRagDataServiceClient.batchDeleteRagMetadataOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<BatchDeleteRagMetadataRequest,Empty,DeleteOperationMetadata>

close()

public final void close()

createRagCorpusAsync(CreateRagCorpusRequest request)

public final OperationFuture<RagCorpus,CreateRagCorpusOperationMetadata> createRagCorpusAsync(CreateRagCorpusRequest request)

Creates a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   CreateRagCorpusRequest request =
       CreateRagCorpusRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRagCorpus(RagCorpus.newBuilder().build())
           .build();
   RagCorpus response = vertexRagDataServiceClient.createRagCorpusAsync(request).get();
 }
Parameter
Name Description
request CreateRagCorpusRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<RagCorpus,CreateRagCorpusOperationMetadata>

createRagCorpusAsync(LocationName parent, RagCorpus ragCorpus)

public final OperationFuture<RagCorpus,CreateRagCorpusOperationMetadata> createRagCorpusAsync(LocationName parent, RagCorpus ragCorpus)

Creates a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   RagCorpus ragCorpus = RagCorpus.newBuilder().build();
   RagCorpus response = vertexRagDataServiceClient.createRagCorpusAsync(parent, ragCorpus).get();
 }
Parameters
Name Description
parent LocationName

Required. The resource name of the Location to create the RagCorpus in. Format: projects/{project}/locations/{location}
ragCorpus RagCorpus

Required. The RagCorpus to create.
Returns
Type Description
OperationFuture<RagCorpus,CreateRagCorpusOperationMetadata>

createRagCorpusAsync(String parent, RagCorpus ragCorpus)

public final OperationFuture<RagCorpus,CreateRagCorpusOperationMetadata> createRagCorpusAsync(String parent, RagCorpus ragCorpus)

Creates a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   RagCorpus ragCorpus = RagCorpus.newBuilder().build();
   RagCorpus response = vertexRagDataServiceClient.createRagCorpusAsync(parent, ragCorpus).get();
 }
Parameters
Name Description
parent String

Required. The resource name of the Location to create the RagCorpus in. Format: projects/{project}/locations/{location}
ragCorpus RagCorpus

Required. The RagCorpus to create.
Returns
Type Description
OperationFuture<RagCorpus,CreateRagCorpusOperationMetadata>

createRagCorpusCallable()

public final UnaryCallable<CreateRagCorpusRequest,Operation> createRagCorpusCallable()

Creates a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   CreateRagCorpusRequest request =
       CreateRagCorpusRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRagCorpus(RagCorpus.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       vertexRagDataServiceClient.createRagCorpusCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateRagCorpusRequest,Operation>

createRagCorpusOperationCallable()

public final OperationCallable<CreateRagCorpusRequest,RagCorpus,CreateRagCorpusOperationMetadata> createRagCorpusOperationCallable()

Creates a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   CreateRagCorpusRequest request =
       CreateRagCorpusRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRagCorpus(RagCorpus.newBuilder().build())
           .build();
   OperationFuture<RagCorpus, CreateRagCorpusOperationMetadata> future =
       vertexRagDataServiceClient.createRagCorpusOperationCallable().futureCall(request);
   // Do something.
   RagCorpus response = future.get();
 }
Returns
Type Description
OperationCallable<CreateRagCorpusRequest,RagCorpus,CreateRagCorpusOperationMetadata>

createRagDataSchema(CreateRagDataSchemaRequest request)

public final RagDataSchema createRagDataSchema(CreateRagDataSchemaRequest request)

Creates a RagDataSchema.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   CreateRagDataSchemaRequest request =
       CreateRagDataSchemaRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setRagDataSchema(RagDataSchema.newBuilder().build())
           .setRagDataSchemaId("ragDataSchemaId-1094185826")
           .build();
   RagDataSchema response = vertexRagDataServiceClient.createRagDataSchema(request);
 }
Parameter
Name Description
request CreateRagDataSchemaRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RagDataSchema

createRagDataSchema(RagCorpusName parent, RagDataSchema ragDataSchema, String ragDataSchemaId)

public final RagDataSchema createRagDataSchema(RagCorpusName parent, RagDataSchema ragDataSchema, String ragDataSchemaId)

Creates a RagDataSchema.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagCorpusName parent = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]");
   RagDataSchema ragDataSchema = RagDataSchema.newBuilder().build();
   String ragDataSchemaId = "ragDataSchemaId-1094185826";
   RagDataSchema response =
       vertexRagDataServiceClient.createRagDataSchema(parent, ragDataSchema, ragDataSchemaId);
 }
Parameters
Name Description
parent RagCorpusName

Required. The resource name of the RagCorpus to create the RagDataSchema in. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
ragDataSchema RagDataSchema

Required. The RagDataSchema to create.
ragDataSchemaId String

Optional. The ID to use for the RagDataSchema, which will become the final component of the RagDataSchema's resource name if the user chooses to specify. Otherwise, RagDataSchema id will be generated by system.

This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
Returns
Type Description
RagDataSchema

createRagDataSchema(String parent, RagDataSchema ragDataSchema, String ragDataSchemaId)

public final RagDataSchema createRagDataSchema(String parent, RagDataSchema ragDataSchema, String ragDataSchemaId)

Creates a RagDataSchema.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String parent = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString();
   RagDataSchema ragDataSchema = RagDataSchema.newBuilder().build();
   String ragDataSchemaId = "ragDataSchemaId-1094185826";
   RagDataSchema response =
       vertexRagDataServiceClient.createRagDataSchema(parent, ragDataSchema, ragDataSchemaId);
 }
Parameters
Name Description
parent String

Required. The resource name of the RagCorpus to create the RagDataSchema in. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
ragDataSchema RagDataSchema

Required. The RagDataSchema to create.
ragDataSchemaId String

Optional. The ID to use for the RagDataSchema, which will become the final component of the RagDataSchema's resource name if the user chooses to specify. Otherwise, RagDataSchema id will be generated by system.

This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
Returns
Type Description
RagDataSchema

createRagDataSchemaCallable()

public final UnaryCallable<CreateRagDataSchemaRequest,RagDataSchema> createRagDataSchemaCallable()

Creates a RagDataSchema.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   CreateRagDataSchemaRequest request =
       CreateRagDataSchemaRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setRagDataSchema(RagDataSchema.newBuilder().build())
           .setRagDataSchemaId("ragDataSchemaId-1094185826")
           .build();
   ApiFuture<RagDataSchema> future =
       vertexRagDataServiceClient.createRagDataSchemaCallable().futureCall(request);
   // Do something.
   RagDataSchema response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateRagDataSchemaRequest,RagDataSchema>

createRagMetadata(CreateRagMetadataRequest request)

public final RagMetadata createRagMetadata(CreateRagMetadataRequest request)

Creates a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   CreateRagMetadataRequest request =
       CreateRagMetadataRequest.newBuilder()
           .setParent(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .setRagMetadata(RagMetadata.newBuilder().build())
           .setRagMetadataId("ragMetadataId-818296094")
           .build();
   RagMetadata response = vertexRagDataServiceClient.createRagMetadata(request);
 }
Parameter
Name Description
request CreateRagMetadataRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RagMetadata

createRagMetadata(RagFileName parent, RagMetadata ragMetadata, String ragMetadataId)

public final RagMetadata createRagMetadata(RagFileName parent, RagMetadata ragMetadata, String ragMetadataId)

Creates a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagFileName parent = RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]");
   RagMetadata ragMetadata = RagMetadata.newBuilder().build();
   String ragMetadataId = "ragMetadataId-818296094";
   RagMetadata response =
       vertexRagDataServiceClient.createRagMetadata(parent, ragMetadata, ragMetadataId);
 }
Parameters
Name Description
parent RagFileName

Required. The parent resource where this metadata will be created. Format: projects/{project_number}/locations/{location_id}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}
ragMetadata RagMetadata

Required. The metadata to create.
ragMetadataId String

Optional. The ID to use for the metadata, which will become the final component of the metadata's resource name if the user chooses to specify. Otherwise, metadata id will be generated by system.

This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
Returns
Type Description
RagMetadata

createRagMetadata(String parent, RagMetadata ragMetadata, String ragMetadataId)

public final RagMetadata createRagMetadata(String parent, RagMetadata ragMetadata, String ragMetadataId)

Creates a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String parent =
       RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]").toString();
   RagMetadata ragMetadata = RagMetadata.newBuilder().build();
   String ragMetadataId = "ragMetadataId-818296094";
   RagMetadata response =
       vertexRagDataServiceClient.createRagMetadata(parent, ragMetadata, ragMetadataId);
 }
Parameters
Name Description
parent String

Required. The parent resource where this metadata will be created. Format: projects/{project_number}/locations/{location_id}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}
ragMetadata RagMetadata

Required. The metadata to create.
ragMetadataId String

Optional. The ID to use for the metadata, which will become the final component of the metadata's resource name if the user chooses to specify. Otherwise, metadata id will be generated by system.

This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
Returns
Type Description
RagMetadata

createRagMetadataCallable()

public final UnaryCallable<CreateRagMetadataRequest,RagMetadata> createRagMetadataCallable()

Creates a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   CreateRagMetadataRequest request =
       CreateRagMetadataRequest.newBuilder()
           .setParent(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .setRagMetadata(RagMetadata.newBuilder().build())
           .setRagMetadataId("ragMetadataId-818296094")
           .build();
   ApiFuture<RagMetadata> future =
       vertexRagDataServiceClient.createRagMetadataCallable().futureCall(request);
   // Do something.
   RagMetadata response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateRagMetadataRequest,RagMetadata>

deleteRagCorpusAsync(DeleteRagCorpusRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteRagCorpusAsync(DeleteRagCorpusRequest request)

Deletes a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   DeleteRagCorpusRequest request =
       DeleteRagCorpusRequest.newBuilder()
           .setName(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setForce(true)
           .setForceDelete(true)
           .build();
   vertexRagDataServiceClient.deleteRagCorpusAsync(request).get();
 }
Parameter
Name Description
request DeleteRagCorpusRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteRagCorpusAsync(RagCorpusName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteRagCorpusAsync(RagCorpusName name)

Deletes a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagCorpusName name = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]");
   vertexRagDataServiceClient.deleteRagCorpusAsync(name).get();
 }
Parameter
Name Description
name RagCorpusName

Required. The name of the RagCorpus resource to be deleted. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteRagCorpusAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteRagCorpusAsync(String name)

Deletes a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String name = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString();
   vertexRagDataServiceClient.deleteRagCorpusAsync(name).get();
 }
Parameter
Name Description
name String

Required. The name of the RagCorpus resource to be deleted. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteRagCorpusCallable()

public final UnaryCallable<DeleteRagCorpusRequest,Operation> deleteRagCorpusCallable()

Deletes a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   DeleteRagCorpusRequest request =
       DeleteRagCorpusRequest.newBuilder()
           .setName(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setForce(true)
           .setForceDelete(true)
           .build();
   ApiFuture<Operation> future =
       vertexRagDataServiceClient.deleteRagCorpusCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteRagCorpusRequest,Operation>

deleteRagCorpusOperationCallable()

public final OperationCallable<DeleteRagCorpusRequest,Empty,DeleteOperationMetadata> deleteRagCorpusOperationCallable()

Deletes a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   DeleteRagCorpusRequest request =
       DeleteRagCorpusRequest.newBuilder()
           .setName(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setForce(true)
           .setForceDelete(true)
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       vertexRagDataServiceClient.deleteRagCorpusOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<DeleteRagCorpusRequest,Empty,DeleteOperationMetadata>

deleteRagDataSchema(DeleteRagDataSchemaRequest request)

public final void deleteRagDataSchema(DeleteRagDataSchemaRequest request)

Deletes a RagDataSchema.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   DeleteRagDataSchemaRequest request =
       DeleteRagDataSchemaRequest.newBuilder()
           .setName(
               RagDataSchemaName.of(
                       "[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_DATA_SCHEMA]")
                   .toString())
           .build();
   vertexRagDataServiceClient.deleteRagDataSchema(request);
 }
Parameter
Name Description
request DeleteRagDataSchemaRequest

The request object containing all of the parameters for the API call.

deleteRagDataSchema(RagDataSchemaName name)

public final void deleteRagDataSchema(RagDataSchemaName name)

Deletes a RagDataSchema.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagDataSchemaName name =
       RagDataSchemaName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_DATA_SCHEMA]");
   vertexRagDataServiceClient.deleteRagDataSchema(name);
 }
Parameter
Name Description
name RagDataSchemaName

Required. The name of the RagDataSchema resource to be deleted. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}

deleteRagDataSchema(String name)

public final void deleteRagDataSchema(String name)

Deletes a RagDataSchema.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String name =
       RagDataSchemaName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_DATA_SCHEMA]")
           .toString();
   vertexRagDataServiceClient.deleteRagDataSchema(name);
 }
Parameter
Name Description
name String

Required. The name of the RagDataSchema resource to be deleted. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}

deleteRagDataSchemaCallable()

public final UnaryCallable<DeleteRagDataSchemaRequest,Empty> deleteRagDataSchemaCallable()

Deletes a RagDataSchema.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   DeleteRagDataSchemaRequest request =
       DeleteRagDataSchemaRequest.newBuilder()
           .setName(
               RagDataSchemaName.of(
                       "[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_DATA_SCHEMA]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       vertexRagDataServiceClient.deleteRagDataSchemaCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteRagDataSchemaRequest,Empty>

deleteRagFileAsync(DeleteRagFileRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteRagFileAsync(DeleteRagFileRequest request)

Deletes a RagFile.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   DeleteRagFileRequest request =
       DeleteRagFileRequest.newBuilder()
           .setName(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .setForceDelete(true)
           .build();
   vertexRagDataServiceClient.deleteRagFileAsync(request).get();
 }
Parameter
Name Description
request DeleteRagFileRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteRagFileAsync(RagFileName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteRagFileAsync(RagFileName name)

Deletes a RagFile.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagFileName name = RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]");
   vertexRagDataServiceClient.deleteRagFileAsync(name).get();
 }
Parameter
Name Description
name RagFileName

Required. The name of the RagFile resource to be deleted. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}
Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteRagFileAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteRagFileAsync(String name)

Deletes a RagFile.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String name =
       RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]").toString();
   vertexRagDataServiceClient.deleteRagFileAsync(name).get();
 }
Parameter
Name Description
name String

Required. The name of the RagFile resource to be deleted. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}
Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteRagFileCallable()

public final UnaryCallable<DeleteRagFileRequest,Operation> deleteRagFileCallable()

Deletes a RagFile.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   DeleteRagFileRequest request =
       DeleteRagFileRequest.newBuilder()
           .setName(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .setForceDelete(true)
           .build();
   ApiFuture<Operation> future =
       vertexRagDataServiceClient.deleteRagFileCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteRagFileRequest,Operation>

deleteRagFileOperationCallable()

public final OperationCallable<DeleteRagFileRequest,Empty,DeleteOperationMetadata> deleteRagFileOperationCallable()

Deletes a RagFile.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   DeleteRagFileRequest request =
       DeleteRagFileRequest.newBuilder()
           .setName(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .setForceDelete(true)
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       vertexRagDataServiceClient.deleteRagFileOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<DeleteRagFileRequest,Empty,DeleteOperationMetadata>

deleteRagMetadata(DeleteRagMetadataRequest request)

public final void deleteRagMetadata(DeleteRagMetadataRequest request)

Deletes a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   DeleteRagMetadataRequest request =
       DeleteRagMetadataRequest.newBuilder()
           .setName(
               RagMetadataName.of(
                       "[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]", "[RAG_METADATA]")
                   .toString())
           .build();
   vertexRagDataServiceClient.deleteRagMetadata(request);
 }
Parameter
Name Description
request DeleteRagMetadataRequest

The request object containing all of the parameters for the API call.

deleteRagMetadata(RagMetadataName name)

public final void deleteRagMetadata(RagMetadataName name)

Deletes a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagMetadataName name =
       RagMetadataName.of(
           "[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]", "[RAG_METADATA]");
   vertexRagDataServiceClient.deleteRagMetadata(name);
 }
Parameter
Name Description
name RagMetadataName

Required. The name of the RagMetadata resource to be deleted. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}

deleteRagMetadata(String name)

public final void deleteRagMetadata(String name)

Deletes a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String name =
       RagMetadataName.of(
               "[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]", "[RAG_METADATA]")
           .toString();
   vertexRagDataServiceClient.deleteRagMetadata(name);
 }
Parameter
Name Description
name String

Required. The name of the RagMetadata resource to be deleted. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}

deleteRagMetadataCallable()

public final UnaryCallable<DeleteRagMetadataRequest,Empty> deleteRagMetadataCallable()

Deletes a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   DeleteRagMetadataRequest request =
       DeleteRagMetadataRequest.newBuilder()
           .setName(
               RagMetadataName.of(
                       "[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]", "[RAG_METADATA]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       vertexRagDataServiceClient.deleteRagMetadataCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteRagMetadataRequest,Empty>

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = vertexRagDataServiceClient.getIamPolicy(request);
 }
Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       vertexRagDataServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = vertexRagDataServiceClient.getLocation(request);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       vertexRagDataServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getRagCorpus(GetRagCorpusRequest request)

public final RagCorpus getRagCorpus(GetRagCorpusRequest request)

Gets a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   GetRagCorpusRequest request =
       GetRagCorpusRequest.newBuilder()
           .setName(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .build();
   RagCorpus response = vertexRagDataServiceClient.getRagCorpus(request);
 }
Parameter
Name Description
request GetRagCorpusRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RagCorpus

getRagCorpus(RagCorpusName name)

public final RagCorpus getRagCorpus(RagCorpusName name)

Gets a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagCorpusName name = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]");
   RagCorpus response = vertexRagDataServiceClient.getRagCorpus(name);
 }
Parameter
Name Description
name RagCorpusName

Required. The name of the RagCorpus resource. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
Returns
Type Description
RagCorpus

getRagCorpus(String name)

public final RagCorpus getRagCorpus(String name)

Gets a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String name = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString();
   RagCorpus response = vertexRagDataServiceClient.getRagCorpus(name);
 }
Parameter
Name Description
name String

Required. The name of the RagCorpus resource. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
Returns
Type Description
RagCorpus

getRagCorpusCallable()

public final UnaryCallable<GetRagCorpusRequest,RagCorpus> getRagCorpusCallable()

Gets a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   GetRagCorpusRequest request =
       GetRagCorpusRequest.newBuilder()
           .setName(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .build();
   ApiFuture<RagCorpus> future =
       vertexRagDataServiceClient.getRagCorpusCallable().futureCall(request);
   // Do something.
   RagCorpus response = future.get();
 }
Returns
Type Description
UnaryCallable<GetRagCorpusRequest,RagCorpus>

getRagDataSchema(GetRagDataSchemaRequest request)

public final RagDataSchema getRagDataSchema(GetRagDataSchemaRequest request)

Gets a RagDataSchema.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   GetRagDataSchemaRequest request =
       GetRagDataSchemaRequest.newBuilder()
           .setName(
               RagDataSchemaName.of(
                       "[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_DATA_SCHEMA]")
                   .toString())
           .build();
   RagDataSchema response = vertexRagDataServiceClient.getRagDataSchema(request);
 }
Parameter
Name Description
request GetRagDataSchemaRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RagDataSchema

getRagDataSchema(RagDataSchemaName name)

public final RagDataSchema getRagDataSchema(RagDataSchemaName name)

Gets a RagDataSchema.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagDataSchemaName name =
       RagDataSchemaName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_DATA_SCHEMA]");
   RagDataSchema response = vertexRagDataServiceClient.getRagDataSchema(name);
 }
Parameter
Name Description
name RagDataSchemaName

Required. The name of the RagDataSchema resource. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}
Returns
Type Description
RagDataSchema

getRagDataSchema(String name)

public final RagDataSchema getRagDataSchema(String name)

Gets a RagDataSchema.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String name =
       RagDataSchemaName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_DATA_SCHEMA]")
           .toString();
   RagDataSchema response = vertexRagDataServiceClient.getRagDataSchema(name);
 }
Parameter
Name Description
name String

Required. The name of the RagDataSchema resource. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}
Returns
Type Description
RagDataSchema

getRagDataSchemaCallable()

public final UnaryCallable<GetRagDataSchemaRequest,RagDataSchema> getRagDataSchemaCallable()

Gets a RagDataSchema.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   GetRagDataSchemaRequest request =
       GetRagDataSchemaRequest.newBuilder()
           .setName(
               RagDataSchemaName.of(
                       "[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_DATA_SCHEMA]")
                   .toString())
           .build();
   ApiFuture<RagDataSchema> future =
       vertexRagDataServiceClient.getRagDataSchemaCallable().futureCall(request);
   // Do something.
   RagDataSchema response = future.get();
 }
Returns
Type Description
UnaryCallable<GetRagDataSchemaRequest,RagDataSchema>

getRagEngineConfig(GetRagEngineConfigRequest request)

public final RagEngineConfig getRagEngineConfig(GetRagEngineConfigRequest request)

Gets a RagEngineConfig.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   GetRagEngineConfigRequest request =
       GetRagEngineConfigRequest.newBuilder()
           .setName(RagEngineConfigName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   RagEngineConfig response = vertexRagDataServiceClient.getRagEngineConfig(request);
 }
Parameter
Name Description
request GetRagEngineConfigRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RagEngineConfig

getRagEngineConfig(RagEngineConfigName name)

public final RagEngineConfig getRagEngineConfig(RagEngineConfigName name)

Gets a RagEngineConfig.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagEngineConfigName name = RagEngineConfigName.of("[PROJECT]", "[LOCATION]");
   RagEngineConfig response = vertexRagDataServiceClient.getRagEngineConfig(name);
 }
Parameter
Name Description
name RagEngineConfigName

Required. The name of the RagEngineConfig resource. Format: projects/{project}/locations/{location}/ragEngineConfig
Returns
Type Description
RagEngineConfig

getRagEngineConfig(String name)

public final RagEngineConfig getRagEngineConfig(String name)

Gets a RagEngineConfig.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String name = RagEngineConfigName.of("[PROJECT]", "[LOCATION]").toString();
   RagEngineConfig response = vertexRagDataServiceClient.getRagEngineConfig(name);
 }
Parameter
Name Description
name String

Required. The name of the RagEngineConfig resource. Format: projects/{project}/locations/{location}/ragEngineConfig
Returns
Type Description
RagEngineConfig

getRagEngineConfigCallable()

public final UnaryCallable<GetRagEngineConfigRequest,RagEngineConfig> getRagEngineConfigCallable()

Gets a RagEngineConfig.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   GetRagEngineConfigRequest request =
       GetRagEngineConfigRequest.newBuilder()
           .setName(RagEngineConfigName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<RagEngineConfig> future =
       vertexRagDataServiceClient.getRagEngineConfigCallable().futureCall(request);
   // Do something.
   RagEngineConfig response = future.get();
 }
Returns
Type Description
UnaryCallable<GetRagEngineConfigRequest,RagEngineConfig>

getRagFile(GetRagFileRequest request)

public final RagFile getRagFile(GetRagFileRequest request)

Gets a RagFile.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   GetRagFileRequest request =
       GetRagFileRequest.newBuilder()
           .setName(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .build();
   RagFile response = vertexRagDataServiceClient.getRagFile(request);
 }
Parameter
Name Description
request GetRagFileRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RagFile

getRagFile(RagFileName name)

public final RagFile getRagFile(RagFileName name)

Gets a RagFile.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagFileName name = RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]");
   RagFile response = vertexRagDataServiceClient.getRagFile(name);
 }
Parameter
Name Description
name RagFileName

Required. The name of the RagFile resource. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}
Returns
Type Description
RagFile

getRagFile(String name)

public final RagFile getRagFile(String name)

Gets a RagFile.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String name =
       RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]").toString();
   RagFile response = vertexRagDataServiceClient.getRagFile(name);
 }
Parameter
Name Description
name String

Required. The name of the RagFile resource. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}
Returns
Type Description
RagFile

getRagFileCallable()

public final UnaryCallable<GetRagFileRequest,RagFile> getRagFileCallable()

Gets a RagFile.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   GetRagFileRequest request =
       GetRagFileRequest.newBuilder()
           .setName(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .build();
   ApiFuture<RagFile> future =
       vertexRagDataServiceClient.getRagFileCallable().futureCall(request);
   // Do something.
   RagFile response = future.get();
 }
Returns
Type Description
UnaryCallable<GetRagFileRequest,RagFile>

getRagMetadata(GetRagMetadataRequest request)

public final RagMetadata getRagMetadata(GetRagMetadataRequest request)

Gets a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   GetRagMetadataRequest request =
       GetRagMetadataRequest.newBuilder()
           .setName(
               RagMetadataName.of(
                       "[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]", "[RAG_METADATA]")
                   .toString())
           .build();
   RagMetadata response = vertexRagDataServiceClient.getRagMetadata(request);
 }
Parameter
Name Description
request GetRagMetadataRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RagMetadata

getRagMetadata(RagMetadataName name)

public final RagMetadata getRagMetadata(RagMetadataName name)

Gets a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagMetadataName name =
       RagMetadataName.of(
           "[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]", "[RAG_METADATA]");
   RagMetadata response = vertexRagDataServiceClient.getRagMetadata(name);
 }
Parameter
Name Description
name RagMetadataName

Required. The name of the RagMetadata resource. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}
Returns
Type Description
RagMetadata

getRagMetadata(String name)

public final RagMetadata getRagMetadata(String name)

Gets a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String name =
       RagMetadataName.of(
               "[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]", "[RAG_METADATA]")
           .toString();
   RagMetadata response = vertexRagDataServiceClient.getRagMetadata(name);
 }
Parameter
Name Description
name String

Required. The name of the RagMetadata resource. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}
Returns
Type Description
RagMetadata

getRagMetadataCallable()

public final UnaryCallable<GetRagMetadataRequest,RagMetadata> getRagMetadataCallable()

Gets a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   GetRagMetadataRequest request =
       GetRagMetadataRequest.newBuilder()
           .setName(
               RagMetadataName.of(
                       "[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]", "[RAG_METADATA]")
                   .toString())
           .build();
   ApiFuture<RagMetadata> future =
       vertexRagDataServiceClient.getRagMetadataCallable().futureCall(request);
   // Do something.
   RagMetadata response = future.get();
 }
Returns
Type Description
UnaryCallable<GetRagMetadataRequest,RagMetadata>

getSettings()

public final VertexRagDataServiceSettings getSettings()
Returns
Type Description
VertexRagDataServiceSettings

getStub()

public VertexRagDataServiceStub getStub()
Returns
Type Description
VertexRagDataServiceStub

importRagFilesAsync(ImportRagFilesRequest request)

public final OperationFuture<ImportRagFilesResponse,ImportRagFilesOperationMetadata> importRagFilesAsync(ImportRagFilesRequest request)

Import files from Google Cloud Storage or Google Drive into a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ImportRagFilesRequest request =
       ImportRagFilesRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setImportRagFilesConfig(ImportRagFilesConfig.newBuilder().build())
           .build();
   ImportRagFilesResponse response =
       vertexRagDataServiceClient.importRagFilesAsync(request).get();
 }
Parameter
Name Description
request ImportRagFilesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<ImportRagFilesResponse,ImportRagFilesOperationMetadata>

importRagFilesAsync(RagCorpusName parent, ImportRagFilesConfig importRagFilesConfig)

public final OperationFuture<ImportRagFilesResponse,ImportRagFilesOperationMetadata> importRagFilesAsync(RagCorpusName parent, ImportRagFilesConfig importRagFilesConfig)

Import files from Google Cloud Storage or Google Drive into a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagCorpusName parent = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]");
   ImportRagFilesConfig importRagFilesConfig = ImportRagFilesConfig.newBuilder().build();
   ImportRagFilesResponse response =
       vertexRagDataServiceClient.importRagFilesAsync(parent, importRagFilesConfig).get();
 }
Parameters
Name Description
parent RagCorpusName

Required. The name of the RagCorpus resource into which to import files. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
importRagFilesConfig ImportRagFilesConfig

Required. The config for the RagFiles to be synced and imported into the RagCorpus. VertexRagDataService.ImportRagFiles.
Returns
Type Description
OperationFuture<ImportRagFilesResponse,ImportRagFilesOperationMetadata>

importRagFilesAsync(String parent, ImportRagFilesConfig importRagFilesConfig)

public final OperationFuture<ImportRagFilesResponse,ImportRagFilesOperationMetadata> importRagFilesAsync(String parent, ImportRagFilesConfig importRagFilesConfig)

Import files from Google Cloud Storage or Google Drive into a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String parent = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString();
   ImportRagFilesConfig importRagFilesConfig = ImportRagFilesConfig.newBuilder().build();
   ImportRagFilesResponse response =
       vertexRagDataServiceClient.importRagFilesAsync(parent, importRagFilesConfig).get();
 }
Parameters
Name Description
parent String

Required. The name of the RagCorpus resource into which to import files. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
importRagFilesConfig ImportRagFilesConfig

Required. The config for the RagFiles to be synced and imported into the RagCorpus. VertexRagDataService.ImportRagFiles.
Returns
Type Description
OperationFuture<ImportRagFilesResponse,ImportRagFilesOperationMetadata>

importRagFilesCallable()

public final UnaryCallable<ImportRagFilesRequest,Operation> importRagFilesCallable()

Import files from Google Cloud Storage or Google Drive into a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ImportRagFilesRequest request =
       ImportRagFilesRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setImportRagFilesConfig(ImportRagFilesConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       vertexRagDataServiceClient.importRagFilesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<ImportRagFilesRequest,Operation>

importRagFilesOperationCallable()

public final OperationCallable<ImportRagFilesRequest,ImportRagFilesResponse,ImportRagFilesOperationMetadata> importRagFilesOperationCallable()

Import files from Google Cloud Storage or Google Drive into a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ImportRagFilesRequest request =
       ImportRagFilesRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setImportRagFilesConfig(ImportRagFilesConfig.newBuilder().build())
           .build();
   OperationFuture<ImportRagFilesResponse, ImportRagFilesOperationMetadata> future =
       vertexRagDataServiceClient.importRagFilesOperationCallable().futureCall(request);
   // Do something.
   ImportRagFilesResponse response = future.get();
 }
Returns
Type Description
OperationCallable<ImportRagFilesRequest,ImportRagFilesResponse,ImportRagFilesOperationMetadata>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final VertexRagDataServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : vertexRagDataServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
VertexRagDataServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         vertexRagDataServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,VertexRagDataServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       vertexRagDataServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listRagCorpora(ListRagCorporaRequest request)

public final VertexRagDataServiceClient.ListRagCorporaPagedResponse listRagCorpora(ListRagCorporaRequest request)

Lists RagCorpora in a Location.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListRagCorporaRequest request =
       ListRagCorporaRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (RagCorpus element : vertexRagDataServiceClient.listRagCorpora(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListRagCorporaRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
VertexRagDataServiceClient.ListRagCorporaPagedResponse

listRagCorpora(LocationName parent)

public final VertexRagDataServiceClient.ListRagCorporaPagedResponse listRagCorpora(LocationName parent)

Lists RagCorpora in a Location.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (RagCorpus element : vertexRagDataServiceClient.listRagCorpora(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The resource name of the Location from which to list the RagCorpora. Format: projects/{project}/locations/{location}
Returns
Type Description
VertexRagDataServiceClient.ListRagCorporaPagedResponse

listRagCorpora(String parent)

public final VertexRagDataServiceClient.ListRagCorporaPagedResponse listRagCorpora(String parent)

Lists RagCorpora in a Location.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (RagCorpus element : vertexRagDataServiceClient.listRagCorpora(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the Location from which to list the RagCorpora. Format: projects/{project}/locations/{location}
Returns
Type Description
VertexRagDataServiceClient.ListRagCorporaPagedResponse

listRagCorporaCallable()

public final UnaryCallable<ListRagCorporaRequest,ListRagCorporaResponse> listRagCorporaCallable()

Lists RagCorpora in a Location.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListRagCorporaRequest request =
       ListRagCorporaRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListRagCorporaResponse response =
         vertexRagDataServiceClient.listRagCorporaCallable().call(request);
     for (RagCorpus element : response.getRagCorporaList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListRagCorporaRequest,ListRagCorporaResponse>

listRagCorporaPagedCallable()

public final UnaryCallable<ListRagCorporaRequest,VertexRagDataServiceClient.ListRagCorporaPagedResponse> listRagCorporaPagedCallable()

Lists RagCorpora in a Location.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListRagCorporaRequest request =
       ListRagCorporaRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<RagCorpus> future =
       vertexRagDataServiceClient.listRagCorporaPagedCallable().futureCall(request);
   // Do something.
   for (RagCorpus element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListRagCorporaRequest,ListRagCorporaPagedResponse>

listRagDataSchemas(ListRagDataSchemasRequest request)

public final VertexRagDataServiceClient.ListRagDataSchemasPagedResponse listRagDataSchemas(ListRagDataSchemasRequest request)

Lists RagDataSchemas in a Location.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListRagDataSchemasRequest request =
       ListRagDataSchemasRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (RagDataSchema element :
       vertexRagDataServiceClient.listRagDataSchemas(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListRagDataSchemasRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
VertexRagDataServiceClient.ListRagDataSchemasPagedResponse

listRagDataSchemas(RagCorpusName parent)

public final VertexRagDataServiceClient.ListRagDataSchemasPagedResponse listRagDataSchemas(RagCorpusName parent)

Lists RagDataSchemas in a Location.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagCorpusName parent = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]");
   for (RagDataSchema element :
       vertexRagDataServiceClient.listRagDataSchemas(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent RagCorpusName

Required. The resource name of the RagCorpus from which to list the RagDataSchemas. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
Returns
Type Description
VertexRagDataServiceClient.ListRagDataSchemasPagedResponse

listRagDataSchemas(String parent)

public final VertexRagDataServiceClient.ListRagDataSchemasPagedResponse listRagDataSchemas(String parent)

Lists RagDataSchemas in a Location.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String parent = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString();
   for (RagDataSchema element :
       vertexRagDataServiceClient.listRagDataSchemas(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the RagCorpus from which to list the RagDataSchemas. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
Returns
Type Description
VertexRagDataServiceClient.ListRagDataSchemasPagedResponse

listRagDataSchemasCallable()

public final UnaryCallable<ListRagDataSchemasRequest,ListRagDataSchemasResponse> listRagDataSchemasCallable()

Lists RagDataSchemas in a Location.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListRagDataSchemasRequest request =
       ListRagDataSchemasRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListRagDataSchemasResponse response =
         vertexRagDataServiceClient.listRagDataSchemasCallable().call(request);
     for (RagDataSchema element : response.getRagDataSchemasList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListRagDataSchemasRequest,ListRagDataSchemasResponse>

listRagDataSchemasPagedCallable()

public final UnaryCallable<ListRagDataSchemasRequest,VertexRagDataServiceClient.ListRagDataSchemasPagedResponse> listRagDataSchemasPagedCallable()

Lists RagDataSchemas in a Location.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListRagDataSchemasRequest request =
       ListRagDataSchemasRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<RagDataSchema> future =
       vertexRagDataServiceClient.listRagDataSchemasPagedCallable().futureCall(request);
   // Do something.
   for (RagDataSchema element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListRagDataSchemasRequest,ListRagDataSchemasPagedResponse>

listRagFiles(ListRagFilesRequest request)

public final VertexRagDataServiceClient.ListRagFilesPagedResponse listRagFiles(ListRagFilesRequest request)

Lists RagFiles in a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListRagFilesRequest request =
       ListRagFilesRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (RagFile element : vertexRagDataServiceClient.listRagFiles(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListRagFilesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
VertexRagDataServiceClient.ListRagFilesPagedResponse

listRagFiles(RagCorpusName parent)

public final VertexRagDataServiceClient.ListRagFilesPagedResponse listRagFiles(RagCorpusName parent)

Lists RagFiles in a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagCorpusName parent = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]");
   for (RagFile element : vertexRagDataServiceClient.listRagFiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent RagCorpusName

Required. The resource name of the RagCorpus from which to list the RagFiles. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
Returns
Type Description
VertexRagDataServiceClient.ListRagFilesPagedResponse

listRagFiles(String parent)

public final VertexRagDataServiceClient.ListRagFilesPagedResponse listRagFiles(String parent)

Lists RagFiles in a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String parent = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString();
   for (RagFile element : vertexRagDataServiceClient.listRagFiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the RagCorpus from which to list the RagFiles. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
Returns
Type Description
VertexRagDataServiceClient.ListRagFilesPagedResponse

listRagFilesCallable()

public final UnaryCallable<ListRagFilesRequest,ListRagFilesResponse> listRagFilesCallable()

Lists RagFiles in a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListRagFilesRequest request =
       ListRagFilesRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListRagFilesResponse response =
         vertexRagDataServiceClient.listRagFilesCallable().call(request);
     for (RagFile element : response.getRagFilesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListRagFilesRequest,ListRagFilesResponse>

listRagFilesPagedCallable()

public final UnaryCallable<ListRagFilesRequest,VertexRagDataServiceClient.ListRagFilesPagedResponse> listRagFilesPagedCallable()

Lists RagFiles in a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListRagFilesRequest request =
       ListRagFilesRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<RagFile> future =
       vertexRagDataServiceClient.listRagFilesPagedCallable().futureCall(request);
   // Do something.
   for (RagFile element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListRagFilesRequest,ListRagFilesPagedResponse>

listRagMetadata(ListRagMetadataRequest request)

public final VertexRagDataServiceClient.ListRagMetadataPagedResponse listRagMetadata(ListRagMetadataRequest request)

Lists RagMetadata in a RagFile.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListRagMetadataRequest request =
       ListRagMetadataRequest.newBuilder()
           .setParent(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (RagMetadata element : vertexRagDataServiceClient.listRagMetadata(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListRagMetadataRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
VertexRagDataServiceClient.ListRagMetadataPagedResponse

listRagMetadata(RagFileName parent)

public final VertexRagDataServiceClient.ListRagMetadataPagedResponse listRagMetadata(RagFileName parent)

Lists RagMetadata in a RagFile.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagFileName parent = RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]");
   for (RagMetadata element : vertexRagDataServiceClient.listRagMetadata(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent RagFileName

Required. The resource name of the RagFile from which to list the RagMetadata. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}
Returns
Type Description
VertexRagDataServiceClient.ListRagMetadataPagedResponse

listRagMetadata(String parent)

public final VertexRagDataServiceClient.ListRagMetadataPagedResponse listRagMetadata(String parent)

Lists RagMetadata in a RagFile.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String parent =
       RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]").toString();
   for (RagMetadata element : vertexRagDataServiceClient.listRagMetadata(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the RagFile from which to list the RagMetadata. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}
Returns
Type Description
VertexRagDataServiceClient.ListRagMetadataPagedResponse

listRagMetadataCallable()

public final UnaryCallable<ListRagMetadataRequest,ListRagMetadataResponse> listRagMetadataCallable()

Lists RagMetadata in a RagFile.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListRagMetadataRequest request =
       ListRagMetadataRequest.newBuilder()
           .setParent(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListRagMetadataResponse response =
         vertexRagDataServiceClient.listRagMetadataCallable().call(request);
     for (RagMetadata element : response.getRagMetadataList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListRagMetadataRequest,ListRagMetadataResponse>

listRagMetadataPagedCallable()

public final UnaryCallable<ListRagMetadataRequest,VertexRagDataServiceClient.ListRagMetadataPagedResponse> listRagMetadataPagedCallable()

Lists RagMetadata in a RagFile.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   ListRagMetadataRequest request =
       ListRagMetadataRequest.newBuilder()
           .setParent(
               RagFileName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]", "[RAG_FILE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<RagMetadata> future =
       vertexRagDataServiceClient.listRagMetadataPagedCallable().futureCall(request);
   // Do something.
   for (RagMetadata element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListRagMetadataRequest,ListRagMetadataPagedResponse>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = vertexRagDataServiceClient.setIamPolicy(request);
 }
Parameter
Name Description
request com.google.iam.v1.SetIamPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       vertexRagDataServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = vertexRagDataServiceClient.testIamPermissions(request);
 }
Parameter
Name Description
request com.google.iam.v1.TestIamPermissionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       vertexRagDataServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateRagCorpusAsync(RagCorpus ragCorpus)

public final OperationFuture<RagCorpus,UpdateRagCorpusOperationMetadata> updateRagCorpusAsync(RagCorpus ragCorpus)

Updates a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagCorpus ragCorpus = RagCorpus.newBuilder().build();
   RagCorpus response = vertexRagDataServiceClient.updateRagCorpusAsync(ragCorpus).get();
 }
Parameter
Name Description
ragCorpus RagCorpus

Required. The RagCorpus which replaces the resource on the server.
Returns
Type Description
OperationFuture<RagCorpus,UpdateRagCorpusOperationMetadata>

updateRagCorpusAsync(UpdateRagCorpusRequest request)

public final OperationFuture<RagCorpus,UpdateRagCorpusOperationMetadata> updateRagCorpusAsync(UpdateRagCorpusRequest request)

Updates a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   UpdateRagCorpusRequest request =
       UpdateRagCorpusRequest.newBuilder().setRagCorpus(RagCorpus.newBuilder().build()).build();
   RagCorpus response = vertexRagDataServiceClient.updateRagCorpusAsync(request).get();
 }
Parameter
Name Description
request UpdateRagCorpusRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<RagCorpus,UpdateRagCorpusOperationMetadata>

updateRagCorpusCallable()

public final UnaryCallable<UpdateRagCorpusRequest,Operation> updateRagCorpusCallable()

Updates a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   UpdateRagCorpusRequest request =
       UpdateRagCorpusRequest.newBuilder().setRagCorpus(RagCorpus.newBuilder().build()).build();
   ApiFuture<Operation> future =
       vertexRagDataServiceClient.updateRagCorpusCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateRagCorpusRequest,Operation>

updateRagCorpusOperationCallable()

public final OperationCallable<UpdateRagCorpusRequest,RagCorpus,UpdateRagCorpusOperationMetadata> updateRagCorpusOperationCallable()

Updates a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   UpdateRagCorpusRequest request =
       UpdateRagCorpusRequest.newBuilder().setRagCorpus(RagCorpus.newBuilder().build()).build();
   OperationFuture<RagCorpus, UpdateRagCorpusOperationMetadata> future =
       vertexRagDataServiceClient.updateRagCorpusOperationCallable().futureCall(request);
   // Do something.
   RagCorpus response = future.get();
 }
Returns
Type Description
OperationCallable<UpdateRagCorpusRequest,RagCorpus,UpdateRagCorpusOperationMetadata>

updateRagEngineConfigAsync(RagEngineConfig ragEngineConfig)

public final OperationFuture<RagEngineConfig,UpdateRagEngineConfigOperationMetadata> updateRagEngineConfigAsync(RagEngineConfig ragEngineConfig)

Updates a RagEngineConfig.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagEngineConfig ragEngineConfig = RagEngineConfig.newBuilder().build();
   RagEngineConfig response =
       vertexRagDataServiceClient.updateRagEngineConfigAsync(ragEngineConfig).get();
 }
Parameter
Name Description
ragEngineConfig RagEngineConfig

Required. The updated RagEngineConfig.

NOTE: Downgrading your RagManagedDb's ComputeTier could temporarily increase request latencies until the operation is fully complete.
Returns
Type Description
OperationFuture<RagEngineConfig,UpdateRagEngineConfigOperationMetadata>

updateRagEngineConfigAsync(UpdateRagEngineConfigRequest request)

public final OperationFuture<RagEngineConfig,UpdateRagEngineConfigOperationMetadata> updateRagEngineConfigAsync(UpdateRagEngineConfigRequest request)

Updates a RagEngineConfig.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   UpdateRagEngineConfigRequest request =
       UpdateRagEngineConfigRequest.newBuilder()
           .setRagEngineConfig(RagEngineConfig.newBuilder().build())
           .build();
   RagEngineConfig response =
       vertexRagDataServiceClient.updateRagEngineConfigAsync(request).get();
 }
Parameter
Name Description
request UpdateRagEngineConfigRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<RagEngineConfig,UpdateRagEngineConfigOperationMetadata>

updateRagEngineConfigCallable()

public final UnaryCallable<UpdateRagEngineConfigRequest,Operation> updateRagEngineConfigCallable()

Updates a RagEngineConfig.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   UpdateRagEngineConfigRequest request =
       UpdateRagEngineConfigRequest.newBuilder()
           .setRagEngineConfig(RagEngineConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       vertexRagDataServiceClient.updateRagEngineConfigCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateRagEngineConfigRequest,Operation>

updateRagEngineConfigOperationCallable()

public final OperationCallable<UpdateRagEngineConfigRequest,RagEngineConfig,UpdateRagEngineConfigOperationMetadata> updateRagEngineConfigOperationCallable()

Updates a RagEngineConfig.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   UpdateRagEngineConfigRequest request =
       UpdateRagEngineConfigRequest.newBuilder()
           .setRagEngineConfig(RagEngineConfig.newBuilder().build())
           .build();
   OperationFuture<RagEngineConfig, UpdateRagEngineConfigOperationMetadata> future =
       vertexRagDataServiceClient.updateRagEngineConfigOperationCallable().futureCall(request);
   // Do something.
   RagEngineConfig response = future.get();
 }
Returns
Type Description
OperationCallable<UpdateRagEngineConfigRequest,RagEngineConfig,UpdateRagEngineConfigOperationMetadata>

updateRagMetadata(RagMetadata ragMetadata)

public final RagMetadata updateRagMetadata(RagMetadata ragMetadata)

Updates a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagMetadata ragMetadata = RagMetadata.newBuilder().build();
   RagMetadata response = vertexRagDataServiceClient.updateRagMetadata(ragMetadata);
 }
Parameter
Name Description
ragMetadata RagMetadata

Required. The RagMetadata which replaces the resource on the server.
Returns
Type Description
RagMetadata

updateRagMetadata(UpdateRagMetadataRequest request)

public final RagMetadata updateRagMetadata(UpdateRagMetadataRequest request)

Updates a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   UpdateRagMetadataRequest request =
       UpdateRagMetadataRequest.newBuilder()
           .setRagMetadata(RagMetadata.newBuilder().build())
           .build();
   RagMetadata response = vertexRagDataServiceClient.updateRagMetadata(request);
 }
Parameter
Name Description
request UpdateRagMetadataRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RagMetadata

updateRagMetadataCallable()

public final UnaryCallable<UpdateRagMetadataRequest,RagMetadata> updateRagMetadataCallable()

Updates a RagMetadata.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   UpdateRagMetadataRequest request =
       UpdateRagMetadataRequest.newBuilder()
           .setRagMetadata(RagMetadata.newBuilder().build())
           .build();
   ApiFuture<RagMetadata> future =
       vertexRagDataServiceClient.updateRagMetadataCallable().futureCall(request);
   // Do something.
   RagMetadata response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateRagMetadataRequest,RagMetadata>

uploadRagFile(RagCorpusName parent, RagFile ragFile, UploadRagFileConfig uploadRagFileConfig)

public final UploadRagFileResponse uploadRagFile(RagCorpusName parent, RagFile ragFile, UploadRagFileConfig uploadRagFileConfig)

Upload a file into a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   RagCorpusName parent = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]");
   RagFile ragFile = RagFile.newBuilder().build();
   UploadRagFileConfig uploadRagFileConfig = UploadRagFileConfig.newBuilder().build();
   UploadRagFileResponse response =
       vertexRagDataServiceClient.uploadRagFile(parent, ragFile, uploadRagFileConfig);
 }
Parameters
Name Description
parent RagCorpusName

Required. The name of the RagCorpus resource into which to upload the file. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
ragFile RagFile

Required. The RagFile to upload.
uploadRagFileConfig UploadRagFileConfig

Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile.
Returns
Type Description
UploadRagFileResponse

uploadRagFile(UploadRagFileRequest request)

public final UploadRagFileResponse uploadRagFile(UploadRagFileRequest request)

Upload a file into a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   UploadRagFileRequest request =
       UploadRagFileRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setRagFile(RagFile.newBuilder().build())
           .setUploadRagFileConfig(UploadRagFileConfig.newBuilder().build())
           .build();
   UploadRagFileResponse response = vertexRagDataServiceClient.uploadRagFile(request);
 }
Parameter
Name Description
request UploadRagFileRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
UploadRagFileResponse

uploadRagFile(String parent, RagFile ragFile, UploadRagFileConfig uploadRagFileConfig)

public final UploadRagFileResponse uploadRagFile(String parent, RagFile ragFile, UploadRagFileConfig uploadRagFileConfig)

Upload a file into a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   String parent = RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString();
   RagFile ragFile = RagFile.newBuilder().build();
   UploadRagFileConfig uploadRagFileConfig = UploadRagFileConfig.newBuilder().build();
   UploadRagFileResponse response =
       vertexRagDataServiceClient.uploadRagFile(parent, ragFile, uploadRagFileConfig);
 }
Parameters
Name Description
parent String

Required. The name of the RagCorpus resource into which to upload the file. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
ragFile RagFile

Required. The RagFile to upload.
uploadRagFileConfig UploadRagFileConfig

Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile.
Returns
Type Description
UploadRagFileResponse

uploadRagFileCallable()

public final UnaryCallable<UploadRagFileRequest,UploadRagFileResponse> uploadRagFileCallable()

Upload a file into a RagCorpus.

Sample code:


 // 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
 try (VertexRagDataServiceClient vertexRagDataServiceClient =
     VertexRagDataServiceClient.create()) {
   UploadRagFileRequest request =
       UploadRagFileRequest.newBuilder()
           .setParent(RagCorpusName.of("[PROJECT]", "[LOCATION]", "[RAG_CORPUS]").toString())
           .setRagFile(RagFile.newBuilder().build())
           .setUploadRagFileConfig(UploadRagFileConfig.newBuilder().build())
           .build();
   ApiFuture<UploadRagFileResponse> future =
       vertexRagDataServiceClient.uploadRagFileCallable().futureCall(request);
   // Do something.
   UploadRagFileResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<UploadRagFileRequest,UploadRagFileResponse>