Class AclConfigServiceClient (0.47.0)

GitHub RepositoryProduct Reference

Service Description: Service for managing Acl Configuration.

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 (AclConfigServiceClient aclConfigServiceClient = AclConfigServiceClient.create()) {
   UpdateAclConfigRequest request =
       UpdateAclConfigRequest.newBuilder().setAclConfig(AclConfig.newBuilder().build()).build();
   AclConfig response = aclConfigServiceClient.updateAclConfig(request);
 }

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

UpdateAclConfig

Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

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

  • updateAclConfig(UpdateAclConfigRequest request)

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

  • updateAclConfigCallable()

GetAclConfig

Gets the AclConfig.

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

  • getAclConfig(GetAclConfigRequest request)

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

  • getAclConfig(AclConfigName name)

  • getAclConfig(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.

  • getAclConfigCallable()

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 AclConfigServiceSettings 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
 AclConfigServiceSettings aclConfigServiceSettings =
     AclConfigServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AclConfigServiceClient aclConfigServiceClient =
     AclConfigServiceClient.create(aclConfigServiceSettings);

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
 AclConfigServiceSettings aclConfigServiceSettings =
     AclConfigServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AclConfigServiceClient aclConfigServiceClient =
     AclConfigServiceClient.create(aclConfigServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 AclConfigServiceSettings aclConfigServiceSettings =
     AclConfigServiceSettings.newHttpJsonBuilder().build();
 AclConfigServiceClient aclConfigServiceClient =
     AclConfigServiceClient.create(aclConfigServiceSettings);

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

Inheritance

java.lang.Object > AclConfigServiceClient

Static Methods

create()

public static final AclConfigServiceClient create()

Constructs an instance of AclConfigServiceClient with default settings.

Returns
Type Description
AclConfigServiceClient
Exceptions
Type Description
IOException

create(AclConfigServiceSettings settings)

public static final AclConfigServiceClient create(AclConfigServiceSettings settings)

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

create(AclConfigServiceStub stub)

public static final AclConfigServiceClient create(AclConfigServiceStub stub)

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

Parameter
Name Description
stub AclConfigServiceStub
Returns
Type Description
AclConfigServiceClient

Constructors

AclConfigServiceClient(AclConfigServiceSettings settings)

protected AclConfigServiceClient(AclConfigServiceSettings settings)

Constructs an instance of AclConfigServiceClient, 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 AclConfigServiceSettings

AclConfigServiceClient(AclConfigServiceStub stub)

protected AclConfigServiceClient(AclConfigServiceStub stub)
Parameter
Name Description
stub AclConfigServiceStub

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

getAclConfig(AclConfigName name)

public final AclConfig getAclConfig(AclConfigName name)

Gets the AclConfig.

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 (AclConfigServiceClient aclConfigServiceClient = AclConfigServiceClient.create()) {
   AclConfigName name = AclConfigName.of("[PROJECT]", "[LOCATION]");
   AclConfig response = aclConfigServiceClient.getAclConfig(name);
 }
Parameter
Name Description
name AclConfigName

Required. Resource name of AclConfig, such as projects/*/locations/*/aclConfig.

If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
Returns
Type Description
AclConfig

getAclConfig(GetAclConfigRequest request)

public final AclConfig getAclConfig(GetAclConfigRequest request)

Gets the AclConfig.

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 (AclConfigServiceClient aclConfigServiceClient = AclConfigServiceClient.create()) {
   GetAclConfigRequest request =
       GetAclConfigRequest.newBuilder()
           .setName(AclConfigName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   AclConfig response = aclConfigServiceClient.getAclConfig(request);
 }
Parameter
Name Description
request GetAclConfigRequest

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

getAclConfig(String name)

public final AclConfig getAclConfig(String name)

Gets the AclConfig.

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 (AclConfigServiceClient aclConfigServiceClient = AclConfigServiceClient.create()) {
   String name = AclConfigName.of("[PROJECT]", "[LOCATION]").toString();
   AclConfig response = aclConfigServiceClient.getAclConfig(name);
 }
Parameter
Name Description
name String

Required. Resource name of AclConfig, such as projects/*/locations/*/aclConfig.

If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
Returns
Type Description
AclConfig

getAclConfigCallable()

public final UnaryCallable<GetAclConfigRequest,AclConfig> getAclConfigCallable()

Gets the AclConfig.

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 (AclConfigServiceClient aclConfigServiceClient = AclConfigServiceClient.create()) {
   GetAclConfigRequest request =
       GetAclConfigRequest.newBuilder()
           .setName(AclConfigName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<AclConfig> future =
       aclConfigServiceClient.getAclConfigCallable().futureCall(request);
   // Do something.
   AclConfig response = future.get();
 }
Returns
Type Description
UnaryCallable<GetAclConfigRequest,AclConfig>

getSettings()

public final AclConfigServiceSettings getSettings()
Returns
Type Description
AclConfigServiceSettings

getStub()

public AclConfigServiceStub getStub()
Returns
Type Description
AclConfigServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAclConfig(UpdateAclConfigRequest request)

public final AclConfig updateAclConfig(UpdateAclConfigRequest request)

Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

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 (AclConfigServiceClient aclConfigServiceClient = AclConfigServiceClient.create()) {
   UpdateAclConfigRequest request =
       UpdateAclConfigRequest.newBuilder().setAclConfig(AclConfig.newBuilder().build()).build();
   AclConfig response = aclConfigServiceClient.updateAclConfig(request);
 }
Parameter
Name Description
request UpdateAclConfigRequest

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

updateAclConfigCallable()

public final UnaryCallable<UpdateAclConfigRequest,AclConfig> updateAclConfigCallable()

Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

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 (AclConfigServiceClient aclConfigServiceClient = AclConfigServiceClient.create()) {
   UpdateAclConfigRequest request =
       UpdateAclConfigRequest.newBuilder().setAclConfig(AclConfig.newBuilder().build()).build();
   ApiFuture<AclConfig> future =
       aclConfigServiceClient.updateAclConfigCallable().futureCall(request);
   // Do something.
   AclConfig response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateAclConfigRequest,AclConfig>