Package com.google.cloud.aiplatform.v1beta1

Class ExtensionExecutionServiceClient

java.lang.Object
com.google.cloud.aiplatform.v1beta1.ExtensionExecutionServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class ExtensionExecutionServiceClient extends Object implements BackgroundResource
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().

Methods
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.

  • executeExtension(ExecuteExtensionRequest request)

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

  • executeExtension(ExtensionName name, String operationId)

  • executeExtension(String name, String operationId)

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

  • executeExtensionCallable()

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.

  • queryExtension(QueryExtensionRequest request)

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

  • queryExtension(ExtensionName name, List<Content> contents)

  • queryExtension(String name, List<Content> contents)

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

  • queryExtensionCallable()

ListLocations

Lists information about the supported locations for this service.

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

  • listLocations(ListLocationsRequest request)

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

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

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

  • getLocation(GetLocationRequest request)

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

  • getLocationCallable()

SetIamPolicy

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

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

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

  • setIamPolicy(SetIamPolicyRequest request)

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

  • setIamPolicyCallable()

GetIamPolicy

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

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

  • getIamPolicy(GetIamPolicyRequest request)

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

  • getIamPolicyCallable()

TestIamPermissions

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

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

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

  • testIamPermissions(TestIamPermissionsRequest request)

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

  • testIamPermissionsCallable()

See the individual methods for example code.

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

This class can be customized by passing in a custom instance of 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.

  • Constructor Details

    • ExtensionExecutionServiceClient

      protected ExtensionExecutionServiceClient(ExtensionExecutionServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • ExtensionExecutionServiceClient

      protected ExtensionExecutionServiceClient(ExtensionExecutionServiceStub stub)

  • Method Details

    • create

      public static final ExtensionExecutionServiceClient create() throws IOException
      Constructs an instance of ExtensionExecutionServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final ExtensionExecutionServiceClient create(ExtensionExecutionServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • create

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

    • getSettings

      public final ExtensionExecutionServiceSettings getSettings()

    • getStub

      public ExtensionExecutionServiceStub getStub()

    • executeExtension

      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 - Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`
      operationId - Required. The desired ID of the operation to be executed in this extension as defined in [ExtensionOperation.operation_id][google.cloud.aiplatform.v1beta1.ExtensionOperation.operation_id].
      Throws:
      ApiException - if the remote call fails

    • executeExtension

      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 - Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`
      operationId - Required. The desired ID of the operation to be executed in this extension as defined in [ExtensionOperation.operation_id][google.cloud.aiplatform.v1beta1.ExtensionOperation.operation_id].
      Throws:
      ApiException - if the remote call fails

    • executeExtension

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

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

    • queryExtension

      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 - Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`
      contents - 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.

      Throws:
      ApiException - if the remote call fails

    • queryExtension

      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 - Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`
      contents - 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.

      Throws:
      ApiException - if the remote call fails

    • queryExtension

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

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

    • listLocations

      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);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

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

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

    • getLocation

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

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

    • setIamPolicy

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

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

    • getIamPolicy

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

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

    • testIamPermissions

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

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

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException