VertexRagDataServiceClient (Google Cloud Vertex AI 3.63.0 API)

java.lang.Object
- com.google.cloud.aiplatform.v1beta1.VertexRagDataServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class VertexRagDataServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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()
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_DENIED`errors.	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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`VertexRagDataServiceClient.ListLocationsFixedSizeCollection`
`static class`	`VertexRagDataServiceClient.ListLocationsPage`
`static class`	`VertexRagDataServiceClient.ListLocationsPagedResponse`
`static class`	`VertexRagDataServiceClient.ListRagCorporaFixedSizeCollection`
`static class`	`VertexRagDataServiceClient.ListRagCorporaPage`
`static class`	`VertexRagDataServiceClient.ListRagCorporaPagedResponse`
`static class`	`VertexRagDataServiceClient.ListRagFilesFixedSizeCollection`
`static class`	`VertexRagDataServiceClient.ListRagFilesPage`
`static class`	`VertexRagDataServiceClient.ListRagFilesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`VertexRagDataServiceClient(VertexRagDataServiceSettings settings)` Constructs an instance of VertexRagDataServiceClient, using the given settings.
`protected`	`VertexRagDataServiceClient(VertexRagDataServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static VertexRagDataServiceClient`	`create()` Constructs an instance of VertexRagDataServiceClient with default settings.
`static VertexRagDataServiceClient`	`create(VertexRagDataServiceSettings settings)` Constructs an instance of VertexRagDataServiceClient, using the given settings.
`static VertexRagDataServiceClient`	`create(VertexRagDataServiceStub stub)` Constructs an instance of VertexRagDataServiceClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<RagCorpus,CreateRagCorpusOperationMetadata>`	`createRagCorpusAsync(CreateRagCorpusRequest request)` Creates a RagCorpus.
`com.google.api.gax.longrunning.OperationFuture<RagCorpus,CreateRagCorpusOperationMetadata>`	`createRagCorpusAsync(LocationName parent, RagCorpus ragCorpus)` Creates a RagCorpus.
`com.google.api.gax.longrunning.OperationFuture<RagCorpus,CreateRagCorpusOperationMetadata>`	`createRagCorpusAsync(String parent, RagCorpus ragCorpus)` Creates a RagCorpus.
`com.google.api.gax.rpc.UnaryCallable<CreateRagCorpusRequest,com.google.longrunning.Operation>`	`createRagCorpusCallable()` Creates a RagCorpus.
`com.google.api.gax.rpc.OperationCallable<CreateRagCorpusRequest,RagCorpus,CreateRagCorpusOperationMetadata>`	`createRagCorpusOperationCallable()` Creates a RagCorpus.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteRagCorpusAsync(DeleteRagCorpusRequest request)` Deletes a RagCorpus.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteRagCorpusAsync(RagCorpusName name)` Deletes a RagCorpus.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteRagCorpusAsync(String name)` Deletes a RagCorpus.
`com.google.api.gax.rpc.UnaryCallable<DeleteRagCorpusRequest,com.google.longrunning.Operation>`	`deleteRagCorpusCallable()` Deletes a RagCorpus.
`com.google.api.gax.rpc.OperationCallable<DeleteRagCorpusRequest,com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteRagCorpusOperationCallable()` Deletes a RagCorpus.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteRagFileAsync(DeleteRagFileRequest request)` Deletes a RagFile.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteRagFileAsync(RagFileName name)` Deletes a RagFile.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteRagFileAsync(String name)` Deletes a RagFile.
`com.google.api.gax.rpc.UnaryCallable<DeleteRagFileRequest,com.google.longrunning.Operation>`	`deleteRagFileCallable()` Deletes a RagFile.
`com.google.api.gax.rpc.OperationCallable<DeleteRagFileRequest,com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteRagFileOperationCallable()` Deletes a RagFile.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`RagCorpus`	`getRagCorpus(GetRagCorpusRequest request)` Gets a RagCorpus.
`RagCorpus`	`getRagCorpus(RagCorpusName name)` Gets a RagCorpus.
`RagCorpus`	`getRagCorpus(String name)` Gets a RagCorpus.
`com.google.api.gax.rpc.UnaryCallable<GetRagCorpusRequest,RagCorpus>`	`getRagCorpusCallable()` Gets a RagCorpus.
`RagEngineConfig`	`getRagEngineConfig(GetRagEngineConfigRequest request)` Gets a RagEngineConfig.
`RagEngineConfig`	`getRagEngineConfig(RagEngineConfigName name)` Gets a RagEngineConfig.
`RagEngineConfig`	`getRagEngineConfig(String name)` Gets a RagEngineConfig.
`com.google.api.gax.rpc.UnaryCallable<GetRagEngineConfigRequest,RagEngineConfig>`	`getRagEngineConfigCallable()` Gets a RagEngineConfig.
`RagFile`	`getRagFile(GetRagFileRequest request)` Gets a RagFile.
`RagFile`	`getRagFile(RagFileName name)` Gets a RagFile.
`RagFile`	`getRagFile(String name)` Gets a RagFile.
`com.google.api.gax.rpc.UnaryCallable<GetRagFileRequest,RagFile>`	`getRagFileCallable()` Gets a RagFile.
`VertexRagDataServiceSettings`	`getSettings()`
`VertexRagDataServiceStub`	`getStub()`
`com.google.api.gax.longrunning.OperationFuture<ImportRagFilesResponse,ImportRagFilesOperationMetadata>`	`importRagFilesAsync(ImportRagFilesRequest request)` Import files from Google Cloud Storage or Google Drive into a RagCorpus.
`com.google.api.gax.longrunning.OperationFuture<ImportRagFilesResponse,ImportRagFilesOperationMetadata>`	`importRagFilesAsync(RagCorpusName parent, ImportRagFilesConfig importRagFilesConfig)` Import files from Google Cloud Storage or Google Drive into a RagCorpus.
`com.google.api.gax.longrunning.OperationFuture<ImportRagFilesResponse,ImportRagFilesOperationMetadata>`	`importRagFilesAsync(String parent, ImportRagFilesConfig importRagFilesConfig)` Import files from Google Cloud Storage or Google Drive into a RagCorpus.
`com.google.api.gax.rpc.UnaryCallable<ImportRagFilesRequest,com.google.longrunning.Operation>`	`importRagFilesCallable()` Import files from Google Cloud Storage or Google Drive into a RagCorpus.
`com.google.api.gax.rpc.OperationCallable<ImportRagFilesRequest,ImportRagFilesResponse,ImportRagFilesOperationMetadata>`	`importRagFilesOperationCallable()` Import files from Google Cloud Storage or Google Drive into a RagCorpus.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`VertexRagDataServiceClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,VertexRagDataServiceClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`VertexRagDataServiceClient.ListRagCorporaPagedResponse`	`listRagCorpora(ListRagCorporaRequest request)` Lists RagCorpora in a Location.
`VertexRagDataServiceClient.ListRagCorporaPagedResponse`	`listRagCorpora(LocationName parent)` Lists RagCorpora in a Location.
`VertexRagDataServiceClient.ListRagCorporaPagedResponse`	`listRagCorpora(String parent)` Lists RagCorpora in a Location.
`com.google.api.gax.rpc.UnaryCallable<ListRagCorporaRequest,ListRagCorporaResponse>`	`listRagCorporaCallable()` Lists RagCorpora in a Location.
`com.google.api.gax.rpc.UnaryCallable<ListRagCorporaRequest,VertexRagDataServiceClient.ListRagCorporaPagedResponse>`	`listRagCorporaPagedCallable()` Lists RagCorpora in a Location.
`VertexRagDataServiceClient.ListRagFilesPagedResponse`	`listRagFiles(ListRagFilesRequest request)` Lists RagFiles in a RagCorpus.
`VertexRagDataServiceClient.ListRagFilesPagedResponse`	`listRagFiles(RagCorpusName parent)` Lists RagFiles in a RagCorpus.
`VertexRagDataServiceClient.ListRagFilesPagedResponse`	`listRagFiles(String parent)` Lists RagFiles in a RagCorpus.
`com.google.api.gax.rpc.UnaryCallable<ListRagFilesRequest,ListRagFilesResponse>`	`listRagFilesCallable()` Lists RagFiles in a RagCorpus.
`com.google.api.gax.rpc.UnaryCallable<ListRagFilesRequest,VertexRagDataServiceClient.ListRagFilesPagedResponse>`	`listRagFilesPagedCallable()` Lists RagFiles in a RagCorpus.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on the specified resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.longrunning.OperationFuture<RagCorpus,UpdateRagCorpusOperationMetadata>`	`updateRagCorpusAsync(RagCorpus ragCorpus)` Updates a RagCorpus.
`com.google.api.gax.longrunning.OperationFuture<RagCorpus,UpdateRagCorpusOperationMetadata>`	`updateRagCorpusAsync(UpdateRagCorpusRequest request)` Updates a RagCorpus.
`com.google.api.gax.rpc.UnaryCallable<UpdateRagCorpusRequest,com.google.longrunning.Operation>`	`updateRagCorpusCallable()` Updates a RagCorpus.
`com.google.api.gax.rpc.OperationCallable<UpdateRagCorpusRequest,RagCorpus,UpdateRagCorpusOperationMetadata>`	`updateRagCorpusOperationCallable()` Updates a RagCorpus.
`com.google.api.gax.longrunning.OperationFuture<RagEngineConfig,UpdateRagEngineConfigOperationMetadata>`	`updateRagEngineConfigAsync(RagEngineConfig ragEngineConfig)` Updates a RagEngineConfig.
`com.google.api.gax.longrunning.OperationFuture<RagEngineConfig,UpdateRagEngineConfigOperationMetadata>`	`updateRagEngineConfigAsync(UpdateRagEngineConfigRequest request)` Updates a RagEngineConfig.
`com.google.api.gax.rpc.UnaryCallable<UpdateRagEngineConfigRequest,com.google.longrunning.Operation>`	`updateRagEngineConfigCallable()` Updates a RagEngineConfig.
`com.google.api.gax.rpc.OperationCallable<UpdateRagEngineConfigRequest,RagEngineConfig,UpdateRagEngineConfigOperationMetadata>`	`updateRagEngineConfigOperationCallable()` Updates a RagEngineConfig.
`UploadRagFileResponse`	`uploadRagFile(RagCorpusName parent, RagFile ragFile, UploadRagFileConfig uploadRagFileConfig)` Upload a file into a RagCorpus.
`UploadRagFileResponse`	`uploadRagFile(String parent, RagFile ragFile, UploadRagFileConfig uploadRagFileConfig)` Upload a file into a RagCorpus.
`UploadRagFileResponse`	`uploadRagFile(UploadRagFileRequest request)` Upload a file into a RagCorpus.
`com.google.api.gax.rpc.UnaryCallable<UploadRagFileRequest,UploadRagFileResponse>`	`uploadRagFileCallable()` Upload a file into a RagCorpus.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- VertexRagDataServiceClient
```
protected VertexRagDataServiceClient(VertexRagDataServiceSettings settings)
                              throws IOException
```
  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.
  
  Throws:
  
  IOException
- VertexRagDataServiceClient
```
protected VertexRagDataServiceClient(VertexRagDataServiceStub stub)
```

Method Detail

create

public static final VertexRagDataServiceClient create()
                                               throws IOException

Constructs an instance of VertexRagDataServiceClient with default settings.

Throws:: IOException

create
```
public static final VertexRagDataServiceClient create(VertexRagDataServiceSettings settings)
                                               throws IOException
```
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.

Throws:

IOException

create
```
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).

getSettings

public final VertexRagDataServiceSettings getSettings()

getStub

public VertexRagDataServiceStub getStub()

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

createRagCorpusAsync

public final com.google.api.gax.longrunning.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:: parent - Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`; ragCorpus - Required. The RagCorpus to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createRagCorpusAsync

public final com.google.api.gax.longrunning.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:: parent - Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`; ragCorpus - Required. The RagCorpus to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createRagCorpusAsync

public final com.google.api.gax.longrunning.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();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createRagCorpusOperationCallable

public final com.google.api.gax.rpc.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();
 }

createRagCorpusCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateRagCorpusRequest,com.google.longrunning.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();
 }

updateRagCorpusAsync

public final com.google.api.gax.longrunning.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();
 }

Parameters:: ragCorpus - Required. The RagCorpus which replaces the resource on the server.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateRagCorpusAsync

public final com.google.api.gax.longrunning.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();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateRagCorpusOperationCallable

public final com.google.api.gax.rpc.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();
 }

updateRagCorpusCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateRagCorpusRequest,com.google.longrunning.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();
 }

getRagCorpus

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);
 }

Parameters:: name - Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getRagCorpus

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);
 }

Parameters:: name - Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getRagCorpus

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getRagCorpusCallable

public final com.google.api.gax.rpc.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();
 }

listRagCorpora

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);
   }
 }

Parameters:: parent - Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listRagCorpora

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);
   }
 }

Parameters:: parent - Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listRagCorpora

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);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listRagCorporaPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }

listRagCorporaCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }

deleteRagCorpusAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }

Parameters:: name - Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteRagCorpusAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }

Parameters:: name - Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteRagCorpusAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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)
           .build();
   vertexRagDataServiceClient.deleteRagCorpusAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteRagCorpusOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteRagCorpusRequest,com.google.protobuf.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)
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       vertexRagDataServiceClient.deleteRagCorpusOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

deleteRagCorpusCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteRagCorpusRequest,com.google.longrunning.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)
           .build();
   ApiFuture<Operation> future =
       vertexRagDataServiceClient.deleteRagCorpusCallable().futureCall(request);
   // Do something.
   future.get();
 }

uploadRagFile

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:: parent - Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`; ragFile - Required. The RagFile to upload.; uploadRagFileConfig - Required. The config for the RagFiles to be uploaded into the RagCorpus. [VertexRagDataService.UploadRagFile][google.cloud.aiplatform.v1beta1.VertexRagDataService.UploadRagFile].
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

uploadRagFile

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:: parent - Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`; ragFile - Required. The RagFile to upload.; uploadRagFileConfig - Required. The config for the RagFiles to be uploaded into the RagCorpus. [VertexRagDataService.UploadRagFile][google.cloud.aiplatform.v1beta1.VertexRagDataService.UploadRagFile].
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

uploadRagFile

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

uploadRagFileCallable

public final com.google.api.gax.rpc.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();
 }

importRagFilesAsync

public final com.google.api.gax.longrunning.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:: parent - Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`; importRagFilesConfig - Required. The config for the RagFiles to be synced and imported into the RagCorpus. [VertexRagDataService.ImportRagFiles][google.cloud.aiplatform.v1beta1.VertexRagDataService.ImportRagFiles].
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

importRagFilesAsync

public final com.google.api.gax.longrunning.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:: parent - Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`; importRagFilesConfig - Required. The config for the RagFiles to be synced and imported into the RagCorpus. [VertexRagDataService.ImportRagFiles][google.cloud.aiplatform.v1beta1.VertexRagDataService.ImportRagFiles].
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

importRagFilesAsync

public final com.google.api.gax.longrunning.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();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

importRagFilesOperationCallable

public final com.google.api.gax.rpc.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();
 }

importRagFilesCallable

public final com.google.api.gax.rpc.UnaryCallable<ImportRagFilesRequest,com.google.longrunning.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();
 }

getRagFile

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);
 }

Parameters:: name - Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getRagFile

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);
 }

Parameters:: name - Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getRagFile

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getRagFileCallable

public final com.google.api.gax.rpc.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();
 }