| GitHub Repository | Product Reference | REST Documentation | RPC Documentation |
Service Description: Manages Vertex AI's Reasoning Engine Revisions.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
ReasoningEngineRuntimeRevisionName name =
ReasoningEngineRuntimeRevisionName.of(
"[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[RUNTIME_REVISION]");
ReasoningEngineRuntimeRevision response =
reasoningEngineRuntimeRevisionServiceClient.getReasoningEngineRuntimeRevision(name);
}
Note: close() needs to be called on the ReasoningEngineRuntimeRevisionServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
GetReasoningEngineRuntimeRevision |
Gets a reasoning engine runtime revision. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListReasoningEngineRuntimeRevisions |
Lists runtime revisions in a reasoning engine. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteReasoningEngineRuntimeRevision |
Deletes a reasoning engine revision. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy |
Sets the access control policy on the specified resource. Replacesany existing policy. Can return |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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 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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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 ReasoningEngineRuntimeRevisionServiceSettings 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
ReasoningEngineRuntimeRevisionServiceSettings reasoningEngineRuntimeRevisionServiceSettings =
ReasoningEngineRuntimeRevisionServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create(
reasoningEngineRuntimeRevisionServiceSettings);
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
ReasoningEngineRuntimeRevisionServiceSettings reasoningEngineRuntimeRevisionServiceSettings =
ReasoningEngineRuntimeRevisionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create(
reasoningEngineRuntimeRevisionServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final ReasoningEngineRuntimeRevisionServiceClient create()Constructs an instance of ReasoningEngineRuntimeRevisionServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
ReasoningEngineRuntimeRevisionServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(ReasoningEngineRuntimeRevisionServiceSettings settings)
public static final ReasoningEngineRuntimeRevisionServiceClient create(ReasoningEngineRuntimeRevisionServiceSettings settings)Constructs an instance of ReasoningEngineRuntimeRevisionServiceClient, 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 |
ReasoningEngineRuntimeRevisionServiceSettings |
| Returns | |
|---|---|
| Type | Description |
ReasoningEngineRuntimeRevisionServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(ReasoningEngineRuntimeRevisionServiceStub stub)
public static final ReasoningEngineRuntimeRevisionServiceClient create(ReasoningEngineRuntimeRevisionServiceStub stub)Constructs an instance of ReasoningEngineRuntimeRevisionServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ReasoningEngineRuntimeRevisionServiceSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
ReasoningEngineRuntimeRevisionServiceStub |
| Returns | |
|---|---|
| Type | Description |
ReasoningEngineRuntimeRevisionServiceClient |
|
Constructors
ReasoningEngineRuntimeRevisionServiceClient(ReasoningEngineRuntimeRevisionServiceSettings settings)
protected ReasoningEngineRuntimeRevisionServiceClient(ReasoningEngineRuntimeRevisionServiceSettings settings)Constructs an instance of ReasoningEngineRuntimeRevisionServiceClient, 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 |
ReasoningEngineRuntimeRevisionServiceSettings |
ReasoningEngineRuntimeRevisionServiceClient(ReasoningEngineRuntimeRevisionServiceStub stub)
protected ReasoningEngineRuntimeRevisionServiceClient(ReasoningEngineRuntimeRevisionServiceStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
ReasoningEngineRuntimeRevisionServiceStub |
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 |
|
close()
public final void close()deleteReasoningEngineRuntimeRevisionAsync(@Nullable ReasoningEngineRuntimeRevisionName name)
public final OperationFuture<Empty,DeleteReasoningEngineRuntimeRevisionOperationMetadata> deleteReasoningEngineRuntimeRevisionAsync(@Nullable ReasoningEngineRuntimeRevisionName name)Deletes a reasoning engine revision.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
ReasoningEngineRuntimeRevisionName name =
ReasoningEngineRuntimeRevisionName.of(
"[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[RUNTIME_REVISION]");
reasoningEngineRuntimeRevisionServiceClient
.deleteReasoningEngineRuntimeRevisionAsync(name)
.get();
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.aiplatform.v1beta1.ReasoningEngineRuntimeRevisionNameRequired. The name of the ReasoningEngineRuntimeRevision resource to be deleted.
Format:
|
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,DeleteReasoningEngineRuntimeRevisionOperationMetadata> |
|
deleteReasoningEngineRuntimeRevisionAsync(DeleteReasoningEngineRuntimeRevisionRequest request)
public final OperationFuture<Empty,DeleteReasoningEngineRuntimeRevisionOperationMetadata> deleteReasoningEngineRuntimeRevisionAsync(DeleteReasoningEngineRuntimeRevisionRequest request)Deletes a reasoning engine revision.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
DeleteReasoningEngineRuntimeRevisionRequest request =
DeleteReasoningEngineRuntimeRevisionRequest.newBuilder()
.setName(
ReasoningEngineRuntimeRevisionName.of(
"[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[RUNTIME_REVISION]")
.toString())
.build();
reasoningEngineRuntimeRevisionServiceClient
.deleteReasoningEngineRuntimeRevisionAsync(request)
.get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteReasoningEngineRuntimeRevisionRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,DeleteReasoningEngineRuntimeRevisionOperationMetadata> |
|
deleteReasoningEngineRuntimeRevisionAsync(String name)
public final OperationFuture<Empty,DeleteReasoningEngineRuntimeRevisionOperationMetadata> deleteReasoningEngineRuntimeRevisionAsync(String name)Deletes a reasoning engine revision.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
String name =
ReasoningEngineRuntimeRevisionName.of(
"[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[RUNTIME_REVISION]")
.toString();
reasoningEngineRuntimeRevisionServiceClient
.deleteReasoningEngineRuntimeRevisionAsync(name)
.get();
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the ReasoningEngineRuntimeRevision resource to be deleted.
Format:
|
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,DeleteReasoningEngineRuntimeRevisionOperationMetadata> |
|
deleteReasoningEngineRuntimeRevisionCallable()
public final UnaryCallable<DeleteReasoningEngineRuntimeRevisionRequest,Operation> deleteReasoningEngineRuntimeRevisionCallable()Deletes a reasoning engine revision.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
DeleteReasoningEngineRuntimeRevisionRequest request =
DeleteReasoningEngineRuntimeRevisionRequest.newBuilder()
.setName(
ReasoningEngineRuntimeRevisionName.of(
"[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[RUNTIME_REVISION]")
.toString())
.build();
ApiFuture<Operation> future =
reasoningEngineRuntimeRevisionServiceClient
.deleteReasoningEngineRuntimeRevisionCallable()
.futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteReasoningEngineRuntimeRevisionRequest,Operation> |
|
deleteReasoningEngineRuntimeRevisionOperationCallable()
public final OperationCallable<DeleteReasoningEngineRuntimeRevisionRequest,Empty,DeleteReasoningEngineRuntimeRevisionOperationMetadata> deleteReasoningEngineRuntimeRevisionOperationCallable()Deletes a reasoning engine revision.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
DeleteReasoningEngineRuntimeRevisionRequest request =
DeleteReasoningEngineRuntimeRevisionRequest.newBuilder()
.setName(
ReasoningEngineRuntimeRevisionName.of(
"[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[RUNTIME_REVISION]")
.toString())
.build();
OperationFuture<Empty, DeleteReasoningEngineRuntimeRevisionOperationMetadata> future =
reasoningEngineRuntimeRevisionServiceClient
.deleteReasoningEngineRuntimeRevisionOperationCallable()
.futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<DeleteReasoningEngineRuntimeRevisionRequest,Empty,DeleteReasoningEngineRuntimeRevisionOperationMetadata> |
|
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = reasoningEngineRuntimeRevisionServiceClient.getIamPolicy(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.iam.v1.GetIamPolicyRequestThe 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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future =
reasoningEngineRuntimeRevisionServiceClient.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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = reasoningEngineRuntimeRevisionServiceClient.getLocation(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.cloud.location.GetLocationRequestThe 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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future =
reasoningEngineRuntimeRevisionServiceClient.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 |
|
getReasoningEngineRuntimeRevision(@Nullable ReasoningEngineRuntimeRevisionName name)
public final ReasoningEngineRuntimeRevision getReasoningEngineRuntimeRevision(@Nullable ReasoningEngineRuntimeRevisionName name)Gets a reasoning engine runtime revision.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
ReasoningEngineRuntimeRevisionName name =
ReasoningEngineRuntimeRevisionName.of(
"[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[RUNTIME_REVISION]");
ReasoningEngineRuntimeRevision response =
reasoningEngineRuntimeRevisionServiceClient.getReasoningEngineRuntimeRevision(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.aiplatform.v1beta1.ReasoningEngineRuntimeRevisionNameRequired. The name of the ReasoningEngineRuntimeRevision resource. Format:
|
| Returns | |
|---|---|
| Type | Description |
ReasoningEngineRuntimeRevision |
|
getReasoningEngineRuntimeRevision(GetReasoningEngineRuntimeRevisionRequest request)
public final ReasoningEngineRuntimeRevision getReasoningEngineRuntimeRevision(GetReasoningEngineRuntimeRevisionRequest request)Gets a reasoning engine runtime revision.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
GetReasoningEngineRuntimeRevisionRequest request =
GetReasoningEngineRuntimeRevisionRequest.newBuilder()
.setName(
ReasoningEngineRuntimeRevisionName.of(
"[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[RUNTIME_REVISION]")
.toString())
.build();
ReasoningEngineRuntimeRevision response =
reasoningEngineRuntimeRevisionServiceClient.getReasoningEngineRuntimeRevision(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetReasoningEngineRuntimeRevisionRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ReasoningEngineRuntimeRevision |
|
getReasoningEngineRuntimeRevision(String name)
public final ReasoningEngineRuntimeRevision getReasoningEngineRuntimeRevision(String name)Gets a reasoning engine runtime revision.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
String name =
ReasoningEngineRuntimeRevisionName.of(
"[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[RUNTIME_REVISION]")
.toString();
ReasoningEngineRuntimeRevision response =
reasoningEngineRuntimeRevisionServiceClient.getReasoningEngineRuntimeRevision(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the ReasoningEngineRuntimeRevision resource. Format:
|
| Returns | |
|---|---|
| Type | Description |
ReasoningEngineRuntimeRevision |
|
getReasoningEngineRuntimeRevisionCallable()
public final UnaryCallable<GetReasoningEngineRuntimeRevisionRequest,ReasoningEngineRuntimeRevision> getReasoningEngineRuntimeRevisionCallable()Gets a reasoning engine runtime revision.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
GetReasoningEngineRuntimeRevisionRequest request =
GetReasoningEngineRuntimeRevisionRequest.newBuilder()
.setName(
ReasoningEngineRuntimeRevisionName.of(
"[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]", "[RUNTIME_REVISION]")
.toString())
.build();
ApiFuture<ReasoningEngineRuntimeRevision> future =
reasoningEngineRuntimeRevisionServiceClient
.getReasoningEngineRuntimeRevisionCallable()
.futureCall(request);
// Do something.
ReasoningEngineRuntimeRevision response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetReasoningEngineRuntimeRevisionRequest,ReasoningEngineRuntimeRevision> |
|
getSettings()
public final @Nullable ReasoningEngineRuntimeRevisionServiceSettings getSettings()| Returns | |
|---|---|
| Type | Description |
@org.jspecify.annotations.Nullable com.google.cloud.aiplatform.v1beta1.ReasoningEngineRuntimeRevisionServiceSettings |
|
getStub()
public ReasoningEngineRuntimeRevisionServiceStub getStub()| Returns | |
|---|---|
| Type | Description |
ReasoningEngineRuntimeRevisionServiceStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listLocations(ListLocationsRequest request)
public final ReasoningEngineRuntimeRevisionServiceClient.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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element :
reasoningEngineRuntimeRevisionServiceClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.cloud.location.ListLocationsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ReasoningEngineRuntimeRevisionServiceClient.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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response =
reasoningEngineRuntimeRevisionServiceClient.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,ReasoningEngineRuntimeRevisionServiceClient.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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
reasoningEngineRuntimeRevisionServiceClient
.listLocationsPagedCallable()
.futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
|
listReasoningEngineRuntimeRevisions(@Nullable ReasoningEngineName parent)
public final ReasoningEngineRuntimeRevisionServiceClient.ListReasoningEngineRuntimeRevisionsPagedResponse listReasoningEngineRuntimeRevisions(@Nullable ReasoningEngineName parent)Lists runtime revisions in a reasoning engine.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
ReasoningEngineName parent =
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]");
for (ReasoningEngineRuntimeRevision element :
reasoningEngineRuntimeRevisionServiceClient
.listReasoningEngineRuntimeRevisions(parent)
.iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.aiplatform.v1beta1.ReasoningEngineNameRequired. The resource name of the ReasoningEngine to list the
ReasoningEngineRuntimeRevisions from. Format:
|
| Returns | |
|---|---|
| Type | Description |
ReasoningEngineRuntimeRevisionServiceClient.ListReasoningEngineRuntimeRevisionsPagedResponse |
|
listReasoningEngineRuntimeRevisions(ListReasoningEngineRuntimeRevisionsRequest request)
public final ReasoningEngineRuntimeRevisionServiceClient.ListReasoningEngineRuntimeRevisionsPagedResponse listReasoningEngineRuntimeRevisions(ListReasoningEngineRuntimeRevisionsRequest request)Lists runtime revisions in a reasoning engine.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
ListReasoningEngineRuntimeRevisionsRequest request =
ListReasoningEngineRuntimeRevisionsRequest.newBuilder()
.setParent(
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]")
.toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (ReasoningEngineRuntimeRevision element :
reasoningEngineRuntimeRevisionServiceClient
.listReasoningEngineRuntimeRevisions(request)
.iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListReasoningEngineRuntimeRevisionsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ReasoningEngineRuntimeRevisionServiceClient.ListReasoningEngineRuntimeRevisionsPagedResponse |
|
listReasoningEngineRuntimeRevisions(String parent)
public final ReasoningEngineRuntimeRevisionServiceClient.ListReasoningEngineRuntimeRevisionsPagedResponse listReasoningEngineRuntimeRevisions(String parent)Lists runtime revisions in a reasoning engine.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
String parent =
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]").toString();
for (ReasoningEngineRuntimeRevision element :
reasoningEngineRuntimeRevisionServiceClient
.listReasoningEngineRuntimeRevisions(parent)
.iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The resource name of the ReasoningEngine to list the
ReasoningEngineRuntimeRevisions from. Format:
|
| Returns | |
|---|---|
| Type | Description |
ReasoningEngineRuntimeRevisionServiceClient.ListReasoningEngineRuntimeRevisionsPagedResponse |
|
listReasoningEngineRuntimeRevisionsCallable()
public final UnaryCallable<ListReasoningEngineRuntimeRevisionsRequest,ListReasoningEngineRuntimeRevisionsResponse> listReasoningEngineRuntimeRevisionsCallable()Lists runtime revisions in a reasoning engine.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
ListReasoningEngineRuntimeRevisionsRequest request =
ListReasoningEngineRuntimeRevisionsRequest.newBuilder()
.setParent(
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]")
.toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListReasoningEngineRuntimeRevisionsResponse response =
reasoningEngineRuntimeRevisionServiceClient
.listReasoningEngineRuntimeRevisionsCallable()
.call(request);
for (ReasoningEngineRuntimeRevision element :
response.getReasoningEngineRuntimeRevisionsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListReasoningEngineRuntimeRevisionsRequest,ListReasoningEngineRuntimeRevisionsResponse> |
|
listReasoningEngineRuntimeRevisionsPagedCallable()
public final UnaryCallable<ListReasoningEngineRuntimeRevisionsRequest,ReasoningEngineRuntimeRevisionServiceClient.ListReasoningEngineRuntimeRevisionsPagedResponse> listReasoningEngineRuntimeRevisionsPagedCallable()Lists runtime revisions in a reasoning engine.
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
ListReasoningEngineRuntimeRevisionsRequest request =
ListReasoningEngineRuntimeRevisionsRequest.newBuilder()
.setParent(
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]")
.toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<ReasoningEngineRuntimeRevision> future =
reasoningEngineRuntimeRevisionServiceClient
.listReasoningEngineRuntimeRevisionsPagedCallable()
.futureCall(request);
// Do something.
for (ReasoningEngineRuntimeRevision element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListReasoningEngineRuntimeRevisionsRequest,ListReasoningEngineRuntimeRevisionsPagedResponse> |
|
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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = reasoningEngineRuntimeRevisionServiceClient.setIamPolicy(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.iam.v1.SetIamPolicyRequestThe 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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future =
reasoningEngineRuntimeRevisionServiceClient.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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response =
reasoningEngineRuntimeRevisionServiceClient.testIamPermissions(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.iam.v1.TestIamPermissionsRequestThe 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 (ReasoningEngineRuntimeRevisionServiceClient reasoningEngineRuntimeRevisionServiceClient =
ReasoningEngineRuntimeRevisionServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse> future =
reasoningEngineRuntimeRevisionServiceClient
.testIamPermissionsCallable()
.futureCall(request);
// Do something.
TestIamPermissionsResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
|