Class ExtensionRegistryServiceClient (3.52.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: A service for managing Vertex AI's Extension registry.

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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   ExtensionName name = ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]");
   Extension response = extensionRegistryServiceClient.getExtension(name);
 }

Note: close() needs to be called on the ExtensionRegistryServiceClient 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

ImportExtension

Imports an Extension.

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

  • importExtensionAsync(ImportExtensionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • importExtensionAsync(LocationName parent, Extension extension)

  • importExtensionAsync(String parent, Extension extension)

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

  • importExtensionOperationCallable()

  • importExtensionCallable()

GetExtension

Gets an Extension.

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

  • getExtension(GetExtensionRequest request)

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

  • getExtension(ExtensionName name)

  • getExtension(String name)

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

  • getExtensionCallable()

ListExtensions

Lists Extensions in a location.

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

  • listExtensions(ListExtensionsRequest request)

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

  • listExtensions(LocationName parent)

  • listExtensions(String parent)

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

  • listExtensionsPagedCallable()

  • listExtensionsCallable()

UpdateExtension

Updates an Extension.

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

  • updateExtension(UpdateExtensionRequest request)

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

  • updateExtension(Extension extension, FieldMask updateMask)

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

  • updateExtensionCallable()

DeleteExtension

Deletes an Extension.

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

  • deleteExtensionAsync(DeleteExtensionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteExtensionAsync(ExtensionName name)

  • deleteExtensionAsync(String name)

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

  • deleteExtensionOperationCallable()

  • deleteExtensionCallable()

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

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 ExtensionRegistryServiceSettings 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
 ExtensionRegistryServiceSettings extensionRegistryServiceSettings =
     ExtensionRegistryServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create(extensionRegistryServiceSettings);

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
 ExtensionRegistryServiceSettings extensionRegistryServiceSettings =
     ExtensionRegistryServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create(extensionRegistryServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > ExtensionRegistryServiceClient

Static Methods

create()

public static final ExtensionRegistryServiceClient create()

Constructs an instance of ExtensionRegistryServiceClient with default settings.

Returns
Type Description
ExtensionRegistryServiceClient
Exceptions
Type Description
IOException

create(ExtensionRegistryServiceSettings settings)

public static final ExtensionRegistryServiceClient create(ExtensionRegistryServiceSettings settings)

Constructs an instance of ExtensionRegistryServiceClient, 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 ExtensionRegistryServiceSettings
Returns
Type Description
ExtensionRegistryServiceClient
Exceptions
Type Description
IOException

create(ExtensionRegistryServiceStub stub)

public static final ExtensionRegistryServiceClient create(ExtensionRegistryServiceStub stub)

Constructs an instance of ExtensionRegistryServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ExtensionRegistryServiceSettings).

Parameter
Name Description
stub ExtensionRegistryServiceStub
Returns
Type Description
ExtensionRegistryServiceClient

Constructors

ExtensionRegistryServiceClient(ExtensionRegistryServiceSettings settings)

protected ExtensionRegistryServiceClient(ExtensionRegistryServiceSettings settings)

Constructs an instance of ExtensionRegistryServiceClient, 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 ExtensionRegistryServiceSettings

ExtensionRegistryServiceClient(ExtensionRegistryServiceStub stub)

protected ExtensionRegistryServiceClient(ExtensionRegistryServiceStub stub)
Parameter
Name Description
stub ExtensionRegistryServiceStub

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

deleteExtensionAsync(DeleteExtensionRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteExtensionAsync(DeleteExtensionRequest request)

Deletes an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   DeleteExtensionRequest request =
       DeleteExtensionRequest.newBuilder()
           .setName(ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]").toString())
           .build();
   extensionRegistryServiceClient.deleteExtensionAsync(request).get();
 }
Parameter
Name Description
request DeleteExtensionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteExtensionAsync(ExtensionName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteExtensionAsync(ExtensionName name)

Deletes an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   ExtensionName name = ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]");
   extensionRegistryServiceClient.deleteExtensionAsync(name).get();
 }
Parameter
Name Description
name ExtensionName

Required. The name of the Extension resource to be deleted. Format: projects/{project}/locations/{location}/extensions/{extension}
Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteExtensionAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteExtensionAsync(String name)

Deletes an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   String name = ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]").toString();
   extensionRegistryServiceClient.deleteExtensionAsync(name).get();
 }
Parameter
Name Description
name String

Required. The name of the Extension resource to be deleted. Format: projects/{project}/locations/{location}/extensions/{extension}
Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteExtensionCallable()

public final UnaryCallable<DeleteExtensionRequest,Operation> deleteExtensionCallable()

Deletes an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   DeleteExtensionRequest request =
       DeleteExtensionRequest.newBuilder()
           .setName(ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]").toString())
           .build();
   ApiFuture<Operation> future =
       extensionRegistryServiceClient.deleteExtensionCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteExtensionRequest,Operation>

deleteExtensionOperationCallable()

public final OperationCallable<DeleteExtensionRequest,Empty,DeleteOperationMetadata> deleteExtensionOperationCallable()

Deletes an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   DeleteExtensionRequest request =
       DeleteExtensionRequest.newBuilder()
           .setName(ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]").toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       extensionRegistryServiceClient.deleteExtensionOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<DeleteExtensionRequest,Empty,DeleteOperationMetadata>

getExtension(ExtensionName name)

public final Extension getExtension(ExtensionName name)

Gets an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   ExtensionName name = ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]");
   Extension response = extensionRegistryServiceClient.getExtension(name);
 }
Parameter
Name Description
name ExtensionName

Required. The name of the Extension resource. Format: projects/{project}/locations/{location}/extensions/{extension}
Returns
Type Description
Extension

getExtension(GetExtensionRequest request)

public final Extension getExtension(GetExtensionRequest request)

Gets an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   GetExtensionRequest request =
       GetExtensionRequest.newBuilder()
           .setName(ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]").toString())
           .build();
   Extension response = extensionRegistryServiceClient.getExtension(request);
 }
Parameter
Name Description
request GetExtensionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Extension

getExtension(String name)

public final Extension getExtension(String name)

Gets an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   String name = ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]").toString();
   Extension response = extensionRegistryServiceClient.getExtension(name);
 }
Parameter
Name Description
name String

Required. The name of the Extension resource. Format: projects/{project}/locations/{location}/extensions/{extension}
Returns
Type Description
Extension

getExtensionCallable()

public final UnaryCallable<GetExtensionRequest,Extension> getExtensionCallable()

Gets an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   GetExtensionRequest request =
       GetExtensionRequest.newBuilder()
           .setName(ExtensionName.of("[PROJECT]", "[LOCATION]", "[EXTENSION]").toString())
           .build();
   ApiFuture<Extension> future =
       extensionRegistryServiceClient.getExtensionCallable().futureCall(request);
   // Do something.
   Extension response = future.get();
 }
Returns
Type Description
UnaryCallable<GetExtensionRequest,Extension>

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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = extensionRegistryServiceClient.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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       extensionRegistryServiceClient.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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = extensionRegistryServiceClient.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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       extensionRegistryServiceClient.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

getSettings()

public final ExtensionRegistryServiceSettings getSettings()
Returns
Type Description
ExtensionRegistryServiceSettings

getStub()

public ExtensionRegistryServiceStub getStub()
Returns
Type Description
ExtensionRegistryServiceStub

importExtensionAsync(ImportExtensionRequest request)

public final OperationFuture<Extension,ImportExtensionOperationMetadata> importExtensionAsync(ImportExtensionRequest request)

Imports an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   ImportExtensionRequest request =
       ImportExtensionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setExtension(Extension.newBuilder().build())
           .build();
   Extension response = extensionRegistryServiceClient.importExtensionAsync(request).get();
 }
Parameter
Name Description
request ImportExtensionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Extension,ImportExtensionOperationMetadata>

importExtensionAsync(LocationName parent, Extension extension)

public final OperationFuture<Extension,ImportExtensionOperationMetadata> importExtensionAsync(LocationName parent, Extension extension)

Imports an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Extension extension = Extension.newBuilder().build();
   Extension response =
       extensionRegistryServiceClient.importExtensionAsync(parent, extension).get();
 }
Parameters
Name Description
parent LocationName

Required. The resource name of the Location to import the Extension in. Format: projects/{project}/locations/{location}
extension Extension

Required. The Extension to import.
Returns
Type Description
OperationFuture<Extension,ImportExtensionOperationMetadata>

importExtensionAsync(String parent, Extension extension)

public final OperationFuture<Extension,ImportExtensionOperationMetadata> importExtensionAsync(String parent, Extension extension)

Imports an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Extension extension = Extension.newBuilder().build();
   Extension response =
       extensionRegistryServiceClient.importExtensionAsync(parent, extension).get();
 }
Parameters
Name Description
parent String

Required. The resource name of the Location to import the Extension in. Format: projects/{project}/locations/{location}
extension Extension

Required. The Extension to import.
Returns
Type Description
OperationFuture<Extension,ImportExtensionOperationMetadata>

importExtensionCallable()

public final UnaryCallable<ImportExtensionRequest,Operation> importExtensionCallable()

Imports an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   ImportExtensionRequest request =
       ImportExtensionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setExtension(Extension.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       extensionRegistryServiceClient.importExtensionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<ImportExtensionRequest,Operation>

importExtensionOperationCallable()

public final OperationCallable<ImportExtensionRequest,Extension,ImportExtensionOperationMetadata> importExtensionOperationCallable()

Imports an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   ImportExtensionRequest request =
       ImportExtensionRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setExtension(Extension.newBuilder().build())
           .build();
   OperationFuture<Extension, ImportExtensionOperationMetadata> future =
       extensionRegistryServiceClient.importExtensionOperationCallable().futureCall(request);
   // Do something.
   Extension response = future.get();
 }
Returns
Type Description
OperationCallable<ImportExtensionRequest,Extension,ImportExtensionOperationMetadata>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listExtensions(ListExtensionsRequest request)

public final ExtensionRegistryServiceClient.ListExtensionsPagedResponse listExtensions(ListExtensionsRequest request)

Lists Extensions 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   ListExtensionsRequest request =
       ListExtensionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Extension element :
       extensionRegistryServiceClient.listExtensions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListExtensionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ExtensionRegistryServiceClient.ListExtensionsPagedResponse

listExtensions(LocationName parent)

public final ExtensionRegistryServiceClient.ListExtensionsPagedResponse listExtensions(LocationName parent)

Lists Extensions 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Extension element : extensionRegistryServiceClient.listExtensions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The resource name of the Location to list the Extensions from. Format: projects/{project}/locations/{location}
Returns
Type Description
ExtensionRegistryServiceClient.ListExtensionsPagedResponse

listExtensions(String parent)

public final ExtensionRegistryServiceClient.ListExtensionsPagedResponse listExtensions(String parent)

Lists Extensions 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Extension element : extensionRegistryServiceClient.listExtensions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the Location to list the Extensions from. Format: projects/{project}/locations/{location}
Returns
Type Description
ExtensionRegistryServiceClient.ListExtensionsPagedResponse

listExtensionsCallable()

public final UnaryCallable<ListExtensionsRequest,ListExtensionsResponse> listExtensionsCallable()

Lists Extensions 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   ListExtensionsRequest request =
       ListExtensionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListExtensionsResponse response =
         extensionRegistryServiceClient.listExtensionsCallable().call(request);
     for (Extension element : response.getExtensionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListExtensionsRequest,ListExtensionsResponse>

listExtensionsPagedCallable()

public final UnaryCallable<ListExtensionsRequest,ExtensionRegistryServiceClient.ListExtensionsPagedResponse> listExtensionsPagedCallable()

Lists Extensions 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   ListExtensionsRequest request =
       ListExtensionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Extension> future =
       extensionRegistryServiceClient.listExtensionsPagedCallable().futureCall(request);
   // Do something.
   for (Extension element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListExtensionsRequest,ListExtensionsPagedResponse>

listLocations(ListLocationsRequest request)

public final ExtensionRegistryServiceClient.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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : extensionRegistryServiceClient.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
ExtensionRegistryServiceClient.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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         extensionRegistryServiceClient.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,ExtensionRegistryServiceClient.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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       extensionRegistryServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

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

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = extensionRegistryServiceClient.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_DENIEDerrors.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       extensionRegistryServiceClient.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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response =
       extensionRegistryServiceClient.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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       extensionRegistryServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateExtension(Extension extension, FieldMask updateMask)

public final Extension updateExtension(Extension extension, FieldMask updateMask)

Updates an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   Extension extension = Extension.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Extension response = extensionRegistryServiceClient.updateExtension(extension, updateMask);
 }
Parameters
Name Description
extension Extension

Required. The Extension which replaces the resource on the server.
updateMask FieldMask

Required. Mask specifying which fields to update. Supported fields:

* display_name * description * runtime_config * tool_use_examples * manifest.description
Returns
Type Description
Extension

updateExtension(UpdateExtensionRequest request)

public final Extension updateExtension(UpdateExtensionRequest request)

Updates an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   UpdateExtensionRequest request =
       UpdateExtensionRequest.newBuilder()
           .setExtension(Extension.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Extension response = extensionRegistryServiceClient.updateExtension(request);
 }
Parameter
Name Description
request UpdateExtensionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Extension

updateExtensionCallable()

public final UnaryCallable<UpdateExtensionRequest,Extension> updateExtensionCallable()

Updates an 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 (ExtensionRegistryServiceClient extensionRegistryServiceClient =
     ExtensionRegistryServiceClient.create()) {
   UpdateExtensionRequest request =
       UpdateExtensionRequest.newBuilder()
           .setExtension(Extension.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Extension> future =
       extensionRegistryServiceClient.updateExtensionCallable().futureCall(request);
   // Do something.
   Extension response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateExtensionRequest,Extension>