- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
GitHub Repository | Product Reference | REST Documentation | RPC Documentation |
Service Description: A service for managing Vertex AI's Reasoning Engines.
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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
ReasoningEngineName name =
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]");
ReasoningEngine response = reasoningEngineServiceClient.getReasoningEngine(name);
}
Note: close() needs to be called on the ReasoningEngineServiceClient 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 |
---|---|---|
CreateReasoningEngine | Creates a reasoning engine. |
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.
|
GetReasoningEngine | Gets 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.
|
ListReasoningEngines | Lists reasoning engines in a location. |
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.
|
DeleteReasoningEngine | Deletes a reasoning engine. |
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 ReasoningEngineServiceSettings 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
ReasoningEngineServiceSettings reasoningEngineServiceSettings =
ReasoningEngineServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create(reasoningEngineServiceSettings);
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
ReasoningEngineServiceSettings reasoningEngineServiceSettings =
ReasoningEngineServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create(reasoningEngineServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final ReasoningEngineServiceClient create()
Constructs an instance of ReasoningEngineServiceClient with default settings.
Returns | |
---|---|
Type | Description |
ReasoningEngineServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ReasoningEngineServiceSettings settings)
public static final ReasoningEngineServiceClient create(ReasoningEngineServiceSettings settings)
Constructs an instance of ReasoningEngineServiceClient, 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 | ReasoningEngineServiceSettings |
Returns | |
---|---|
Type | Description |
ReasoningEngineServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ReasoningEngineServiceStub stub)
public static final ReasoningEngineServiceClient create(ReasoningEngineServiceStub stub)
Constructs an instance of ReasoningEngineServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ReasoningEngineServiceSettings).
Parameter | |
---|---|
Name | Description |
stub | ReasoningEngineServiceStub |
Returns | |
---|---|
Type | Description |
ReasoningEngineServiceClient |
Constructors
ReasoningEngineServiceClient(ReasoningEngineServiceSettings settings)
protected ReasoningEngineServiceClient(ReasoningEngineServiceSettings settings)
Constructs an instance of ReasoningEngineServiceClient, 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 | ReasoningEngineServiceSettings |
ReasoningEngineServiceClient(ReasoningEngineServiceStub stub)
protected ReasoningEngineServiceClient(ReasoningEngineServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub | ReasoningEngineServiceStub |
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()
createReasoningEngineAsync(CreateReasoningEngineRequest request)
public final OperationFuture<ReasoningEngine,CreateReasoningEngineOperationMetadata> createReasoningEngineAsync(CreateReasoningEngineRequest request)
Creates 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
CreateReasoningEngineRequest request =
CreateReasoningEngineRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setReasoningEngine(ReasoningEngine.newBuilder().build())
.build();
ReasoningEngine response =
reasoningEngineServiceClient.createReasoningEngineAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | CreateReasoningEngineRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<ReasoningEngine,CreateReasoningEngineOperationMetadata> |
createReasoningEngineAsync(LocationName parent, ReasoningEngine reasoningEngine)
public final OperationFuture<ReasoningEngine,CreateReasoningEngineOperationMetadata> createReasoningEngineAsync(LocationName parent, ReasoningEngine reasoningEngine)
Creates 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
ReasoningEngine reasoningEngine = ReasoningEngine.newBuilder().build();
ReasoningEngine response =
reasoningEngineServiceClient.createReasoningEngineAsync(parent, reasoningEngine).get();
}
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to create the ReasoningEngine in.
Format: |
reasoningEngine | ReasoningEngine Required. The ReasoningEngine to create. |
Returns | |
---|---|
Type | Description |
OperationFuture<ReasoningEngine,CreateReasoningEngineOperationMetadata> |
createReasoningEngineAsync(String parent, ReasoningEngine reasoningEngine)
public final OperationFuture<ReasoningEngine,CreateReasoningEngineOperationMetadata> createReasoningEngineAsync(String parent, ReasoningEngine reasoningEngine)
Creates 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
ReasoningEngine reasoningEngine = ReasoningEngine.newBuilder().build();
ReasoningEngine response =
reasoningEngineServiceClient.createReasoningEngineAsync(parent, reasoningEngine).get();
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The resource name of the Location to create the ReasoningEngine in.
Format: |
reasoningEngine | ReasoningEngine Required. The ReasoningEngine to create. |
Returns | |
---|---|
Type | Description |
OperationFuture<ReasoningEngine,CreateReasoningEngineOperationMetadata> |
createReasoningEngineCallable()
public final UnaryCallable<CreateReasoningEngineRequest,Operation> createReasoningEngineCallable()
Creates 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
CreateReasoningEngineRequest request =
CreateReasoningEngineRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setReasoningEngine(ReasoningEngine.newBuilder().build())
.build();
ApiFuture<Operation> future =
reasoningEngineServiceClient.createReasoningEngineCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateReasoningEngineRequest,Operation> |
createReasoningEngineOperationCallable()
public final OperationCallable<CreateReasoningEngineRequest,ReasoningEngine,CreateReasoningEngineOperationMetadata> createReasoningEngineOperationCallable()
Creates 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
CreateReasoningEngineRequest request =
CreateReasoningEngineRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setReasoningEngine(ReasoningEngine.newBuilder().build())
.build();
OperationFuture<ReasoningEngine, CreateReasoningEngineOperationMetadata> future =
reasoningEngineServiceClient.createReasoningEngineOperationCallable().futureCall(request);
// Do something.
ReasoningEngine response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateReasoningEngineRequest,ReasoningEngine,CreateReasoningEngineOperationMetadata> |
deleteReasoningEngineAsync(DeleteReasoningEngineRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteReasoningEngineAsync(DeleteReasoningEngineRequest request)
Deletes 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
DeleteReasoningEngineRequest request =
DeleteReasoningEngineRequest.newBuilder()
.setName(
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]")
.toString())
.build();
reasoningEngineServiceClient.deleteReasoningEngineAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeleteReasoningEngineRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteReasoningEngineAsync(ReasoningEngineName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteReasoningEngineAsync(ReasoningEngineName name)
Deletes 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
ReasoningEngineName name =
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]");
reasoningEngineServiceClient.deleteReasoningEngineAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | ReasoningEngineName Required. The name of the ReasoningEngine resource to be deleted. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteReasoningEngineAsync(String name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteReasoningEngineAsync(String name)
Deletes 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
String name =
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]").toString();
reasoningEngineServiceClient.deleteReasoningEngineAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the ReasoningEngine resource to be deleted. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteReasoningEngineCallable()
public final UnaryCallable<DeleteReasoningEngineRequest,Operation> deleteReasoningEngineCallable()
Deletes 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
DeleteReasoningEngineRequest request =
DeleteReasoningEngineRequest.newBuilder()
.setName(
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]")
.toString())
.build();
ApiFuture<Operation> future =
reasoningEngineServiceClient.deleteReasoningEngineCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteReasoningEngineRequest,Operation> |
deleteReasoningEngineOperationCallable()
public final OperationCallable<DeleteReasoningEngineRequest,Empty,DeleteOperationMetadata> deleteReasoningEngineOperationCallable()
Deletes 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
DeleteReasoningEngineRequest request =
DeleteReasoningEngineRequest.newBuilder()
.setName(
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]")
.toString())
.build();
OperationFuture<Empty, DeleteOperationMetadata> future =
reasoningEngineServiceClient.deleteReasoningEngineOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteReasoningEngineRequest,Empty,DeleteOperationMetadata> |
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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = reasoningEngineServiceClient.getIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future =
reasoningEngineServiceClient.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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = reasoningEngineServiceClient.getLocation(request);
}
Parameter | |
---|---|
Name | Description |
request | com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future =
reasoningEngineServiceClient.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 |
getReasoningEngine(GetReasoningEngineRequest request)
public final ReasoningEngine getReasoningEngine(GetReasoningEngineRequest request)
Gets 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
GetReasoningEngineRequest request =
GetReasoningEngineRequest.newBuilder()
.setName(
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]")
.toString())
.build();
ReasoningEngine response = reasoningEngineServiceClient.getReasoningEngine(request);
}
Parameter | |
---|---|
Name | Description |
request | GetReasoningEngineRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ReasoningEngine |
getReasoningEngine(ReasoningEngineName name)
public final ReasoningEngine getReasoningEngine(ReasoningEngineName name)
Gets 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
ReasoningEngineName name =
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]");
ReasoningEngine response = reasoningEngineServiceClient.getReasoningEngine(name);
}
Parameter | |
---|---|
Name | Description |
name | ReasoningEngineName Required. The name of the ReasoningEngine resource. Format:
|
Returns | |
---|---|
Type | Description |
ReasoningEngine |
getReasoningEngine(String name)
public final ReasoningEngine getReasoningEngine(String name)
Gets 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
String name =
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]").toString();
ReasoningEngine response = reasoningEngineServiceClient.getReasoningEngine(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the ReasoningEngine resource. Format:
|
Returns | |
---|---|
Type | Description |
ReasoningEngine |
getReasoningEngineCallable()
public final UnaryCallable<GetReasoningEngineRequest,ReasoningEngine> getReasoningEngineCallable()
Gets 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
GetReasoningEngineRequest request =
GetReasoningEngineRequest.newBuilder()
.setName(
ReasoningEngineName.of("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]")
.toString())
.build();
ApiFuture<ReasoningEngine> future =
reasoningEngineServiceClient.getReasoningEngineCallable().futureCall(request);
// Do something.
ReasoningEngine response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetReasoningEngineRequest,ReasoningEngine> |
getSettings()
public final ReasoningEngineServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
ReasoningEngineServiceSettings |
getStub()
public ReasoningEngineServiceStub getStub()
Returns | |
---|---|
Type | Description |
ReasoningEngineServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listLocations(ListLocationsRequest request)
public final ReasoningEngineServiceClient.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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : reasoningEngineServiceClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ReasoningEngineServiceClient.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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response =
reasoningEngineServiceClient.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,ReasoningEngineServiceClient.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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
reasoningEngineServiceClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
listReasoningEngines(ListReasoningEnginesRequest request)
public final ReasoningEngineServiceClient.ListReasoningEnginesPagedResponse listReasoningEngines(ListReasoningEnginesRequest request)
Lists reasoning engines 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
ListReasoningEnginesRequest request =
ListReasoningEnginesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (ReasoningEngine element :
reasoningEngineServiceClient.listReasoningEngines(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListReasoningEnginesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ReasoningEngineServiceClient.ListReasoningEnginesPagedResponse |
listReasoningEngines(LocationName parent)
public final ReasoningEngineServiceClient.ListReasoningEnginesPagedResponse listReasoningEngines(LocationName parent)
Lists reasoning engines 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (ReasoningEngine element :
reasoningEngineServiceClient.listReasoningEngines(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the Location to list the ReasoningEngines from.
Format: |
Returns | |
---|---|
Type | Description |
ReasoningEngineServiceClient.ListReasoningEnginesPagedResponse |
listReasoningEngines(String parent)
public final ReasoningEngineServiceClient.ListReasoningEnginesPagedResponse listReasoningEngines(String parent)
Lists reasoning engines 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (ReasoningEngine element :
reasoningEngineServiceClient.listReasoningEngines(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The resource name of the Location to list the ReasoningEngines from.
Format: |
Returns | |
---|---|
Type | Description |
ReasoningEngineServiceClient.ListReasoningEnginesPagedResponse |
listReasoningEnginesCallable()
public final UnaryCallable<ListReasoningEnginesRequest,ListReasoningEnginesResponse> listReasoningEnginesCallable()
Lists reasoning engines 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
ListReasoningEnginesRequest request =
ListReasoningEnginesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListReasoningEnginesResponse response =
reasoningEngineServiceClient.listReasoningEnginesCallable().call(request);
for (ReasoningEngine element : response.getReasoningEnginesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListReasoningEnginesRequest,ListReasoningEnginesResponse> |
listReasoningEnginesPagedCallable()
public final UnaryCallable<ListReasoningEnginesRequest,ReasoningEngineServiceClient.ListReasoningEnginesPagedResponse> listReasoningEnginesPagedCallable()
Lists reasoning engines 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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
ListReasoningEnginesRequest request =
ListReasoningEnginesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<ReasoningEngine> future =
reasoningEngineServiceClient.listReasoningEnginesPagedCallable().futureCall(request);
// Do something.
for (ReasoningEngine element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListReasoningEnginesRequest,ListReasoningEnginesPagedResponse> |
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_DENIED
errors.
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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = reasoningEngineServiceClient.setIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future =
reasoningEngineServiceClient.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 (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response =
reasoningEngineServiceClient.testIamPermissions(request);
}
Parameter | |
---|---|
Name | Description |
request | com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
testIamPermissionsCallable()
public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource. If theresource does not exist,
this will return an empty set ofpermissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ReasoningEngineServiceClient reasoningEngineServiceClient =
ReasoningEngineServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse> future =
reasoningEngineServiceClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |