- 3.52.0 (latest)
- 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 Extension execution.
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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
ExtensionName name = ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]");
String operationId = "operationId129704162";
ExecuteExtensionResponse response =
extensionExecutionServiceClient.executeExtension(name, operationId);
}
Note: close() needs to be called on the ExtensionExecutionServiceClient 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 |
---|---|---|
ExecuteExtension |
Executes the request against a given extension. |
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.
|
QueryExtension |
Queries an extension with a default controller. |
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.
|
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 ExtensionExecutionServiceSettings 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
ExtensionExecutionServiceSettings extensionExecutionServiceSettings =
ExtensionExecutionServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create(extensionExecutionServiceSettings);
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
ExtensionExecutionServiceSettings extensionExecutionServiceSettings =
ExtensionExecutionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create(extensionExecutionServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final ExtensionExecutionServiceClient create()
Constructs an instance of ExtensionExecutionServiceClient with default settings.
Returns | |
---|---|
Type | Description |
ExtensionExecutionServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ExtensionExecutionServiceSettings settings)
public static final ExtensionExecutionServiceClient create(ExtensionExecutionServiceSettings settings)
Constructs an instance of ExtensionExecutionServiceClient, 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 |
ExtensionExecutionServiceSettings |
Returns | |
---|---|
Type | Description |
ExtensionExecutionServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ExtensionExecutionServiceStub stub)
public static final ExtensionExecutionServiceClient create(ExtensionExecutionServiceStub stub)
Constructs an instance of ExtensionExecutionServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ExtensionExecutionServiceSettings).
Parameter | |
---|---|
Name | Description |
stub |
ExtensionExecutionServiceStub |
Returns | |
---|---|
Type | Description |
ExtensionExecutionServiceClient |
Constructors
ExtensionExecutionServiceClient(ExtensionExecutionServiceSettings settings)
protected ExtensionExecutionServiceClient(ExtensionExecutionServiceSettings settings)
Constructs an instance of ExtensionExecutionServiceClient, 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 |
ExtensionExecutionServiceSettings |
ExtensionExecutionServiceClient(ExtensionExecutionServiceStub stub)
protected ExtensionExecutionServiceClient(ExtensionExecutionServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub |
ExtensionExecutionServiceStub |
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()
executeExtension(ExecuteExtensionRequest request)
public final ExecuteExtensionResponse executeExtension(ExecuteExtensionRequest request)
Executes the request against a given extension.
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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
ExecuteExtensionRequest request =
ExecuteExtensionRequest.newBuilder()
.setName(ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]").toString())
.setOperationId("operationId129704162")
.setOperationParams(Struct.newBuilder().build())
.setRuntimeAuthConfig(AuthConfig.newBuilder().build())
.build();
ExecuteExtensionResponse response = extensionExecutionServiceClient.executeExtension(request);
}
Parameter | |
---|---|
Name | Description |
request |
ExecuteExtensionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ExecuteExtensionResponse |
executeExtension(ExtensionName name, String operationId)
public final ExecuteExtensionResponse executeExtension(ExtensionName name, String operationId)
Executes the request against a given extension.
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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
ExtensionName name = ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]");
String operationId = "operationId129704162";
ExecuteExtensionResponse response =
extensionExecutionServiceClient.executeExtension(name, operationId);
}
Parameters | |
---|---|
Name | Description |
name |
ExtensionName Required. Name (identifier) of the extension; Format:
|
operationId |
String Required. The desired ID of the operation to be executed in this extension as defined in ExtensionOperation.operation_id. |
Returns | |
---|---|
Type | Description |
ExecuteExtensionResponse |
executeExtension(String name, String operationId)
public final ExecuteExtensionResponse executeExtension(String name, String operationId)
Executes the request against a given extension.
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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
String name = ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]").toString();
String operationId = "operationId129704162";
ExecuteExtensionResponse response =
extensionExecutionServiceClient.executeExtension(name, operationId);
}
Parameters | |
---|---|
Name | Description |
name |
String Required. Name (identifier) of the extension; Format:
|
operationId |
String Required. The desired ID of the operation to be executed in this extension as defined in ExtensionOperation.operation_id. |
Returns | |
---|---|
Type | Description |
ExecuteExtensionResponse |
executeExtensionCallable()
public final UnaryCallable<ExecuteExtensionRequest,ExecuteExtensionResponse> executeExtensionCallable()
Executes the request against a given extension.
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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
ExecuteExtensionRequest request =
ExecuteExtensionRequest.newBuilder()
.setName(ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]").toString())
.setOperationId("operationId129704162")
.setOperationParams(Struct.newBuilder().build())
.setRuntimeAuthConfig(AuthConfig.newBuilder().build())
.build();
ApiFuture<ExecuteExtensionResponse> future =
extensionExecutionServiceClient.executeExtensionCallable().futureCall(request);
// Do something.
ExecuteExtensionResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ExecuteExtensionRequest,ExecuteExtensionResponse> |
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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = extensionExecutionServiceClient.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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future =
extensionExecutionServiceClient.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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = extensionExecutionServiceClient.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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future =
extensionExecutionServiceClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getSettings()
public final ExtensionExecutionServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
ExtensionExecutionServiceSettings |
getStub()
public ExtensionExecutionServiceStub getStub()
Returns | |
---|---|
Type | Description |
ExtensionExecutionServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listLocations(ListLocationsRequest request)
public final ExtensionExecutionServiceClient.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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : extensionExecutionServiceClient.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 |
ExtensionExecutionServiceClient.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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response =
extensionExecutionServiceClient.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,ExtensionExecutionServiceClient.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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
extensionExecutionServiceClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
queryExtension(ExtensionName name, List<Content> contents)
public final QueryExtensionResponse queryExtension(ExtensionName name, List<Content> contents)
Queries an extension with a default controller.
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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
ExtensionName name = ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]");
List<Content> contents = new ArrayList<>();
QueryExtensionResponse response =
extensionExecutionServiceClient.queryExtension(name, contents);
}
Parameters | |
---|---|
Name | Description |
name |
ExtensionName Required. Name (identifier) of the extension; Format:
|
contents |
List<Content> Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. |
Returns | |
---|---|
Type | Description |
QueryExtensionResponse |
queryExtension(QueryExtensionRequest request)
public final QueryExtensionResponse queryExtension(QueryExtensionRequest request)
Queries an extension with a default controller.
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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
QueryExtensionRequest request =
QueryExtensionRequest.newBuilder()
.setName(ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]").toString())
.addAllContents(new ArrayList<Content>())
.build();
QueryExtensionResponse response = extensionExecutionServiceClient.queryExtension(request);
}
Parameter | |
---|---|
Name | Description |
request |
QueryExtensionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
QueryExtensionResponse |
queryExtension(String name, List<Content> contents)
public final QueryExtensionResponse queryExtension(String name, List<Content> contents)
Queries an extension with a default controller.
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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
String name = ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]").toString();
List<Content> contents = new ArrayList<>();
QueryExtensionResponse response =
extensionExecutionServiceClient.queryExtension(name, contents);
}
Parameters | |
---|---|
Name | Description |
name |
String Required. Name (identifier) of the extension; Format:
|
contents |
List<Content> Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. |
Returns | |
---|---|
Type | Description |
QueryExtensionResponse |
queryExtensionCallable()
public final UnaryCallable<QueryExtensionRequest,QueryExtensionResponse> queryExtensionCallable()
Queries an extension with a default controller.
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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
QueryExtensionRequest request =
QueryExtensionRequest.newBuilder()
.setName(ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]").toString())
.addAllContents(new ArrayList<Content>())
.build();
ApiFuture<QueryExtensionResponse> future =
extensionExecutionServiceClient.queryExtensionCallable().futureCall(request);
// Do something.
QueryExtensionResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<QueryExtensionRequest,QueryExtensionResponse> |
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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = extensionExecutionServiceClient.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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future =
extensionExecutionServiceClient.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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response =
extensionExecutionServiceClient.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 (ExtensionExecutionServiceClient extensionExecutionServiceClient =
ExtensionExecutionServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse> future =
extensionExecutionServiceClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |