com.google.cloud.discoveryengine.v1alpha

Class AclConfigServiceClient

java.lang.Object

com.google.cloud.discoveryengine.v1alpha.AclConfigServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class AclConfigServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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][google.cloud.discoveryengine.v1alpha.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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AclConfigServiceClient(AclConfigServiceSettings settings) Constructs an instance of AclConfigServiceClient, using the given settings.
protected	AclConfigServiceClient(AclConfigServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static AclConfigServiceClient	create() Constructs an instance of AclConfigServiceClient with default settings.
static AclConfigServiceClient	create(AclConfigServiceSettings settings) Constructs an instance of AclConfigServiceClient, using the given settings.
static AclConfigServiceClient	create(AclConfigServiceStub stub) Constructs an instance of AclConfigServiceClient, using the given stub for making calls.
AclConfig	getAclConfig(AclConfigName name) Gets the [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig].
AclConfig	getAclConfig(GetAclConfigRequest request) Gets the [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig].
AclConfig	getAclConfig(String name) Gets the [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig].
com.google.api.gax.rpc.UnaryCallable<GetAclConfigRequest,AclConfig>	getAclConfigCallable() Gets the [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig].
AclConfigServiceSettings	getSettings()
AclConfigServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()
AclConfig	updateAclConfig(UpdateAclConfigRequest request) Default Acl Configuration for use in a location of a customer's project.
com.google.api.gax.rpc.UnaryCallable<UpdateAclConfigRequest,AclConfig>	updateAclConfigCallable() Default Acl Configuration for use in a location of a customer's project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AclConfigServiceClient

protected AclConfigServiceClient(AclConfigServiceSettings settings)
                          throws IOException

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.

Throws:

IOException

AclConfigServiceClient

protected AclConfigServiceClient(AclConfigServiceStub stub)

Method Detail

create

public static final AclConfigServiceClient create()
                                           throws IOException

Constructs an instance of AclConfigServiceClient with default settings.

Throws:

IOException

create

public static final AclConfigServiceClient create(AclConfigServiceSettings settings)
                                           throws IOException

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.

Throws:

IOException

create

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

getSettings

public final AclConfigServiceSettings getSettings()

getStub

public AclConfigServiceStub getStub()

updateAclConfig

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

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateAclConfigCallable

public final com.google.api.gax.rpc.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();
 }
 

getAclConfig

public final AclConfig getAclConfig(AclConfigName name)

Gets the [AclConfig][google.cloud.discoveryengine.v1alpha.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);
 }
 

Parameters:

name - Required. Resource name of [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], such as `projects/*/locations/*/aclConfig`.

If the caller does not have permission to access the [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getAclConfig

public final AclConfig getAclConfig(String name)

Gets the [AclConfig][google.cloud.discoveryengine.v1alpha.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);
 }
 

Parameters:

name - Required. Resource name of [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], such as `projects/*/locations/*/aclConfig`.

If the caller does not have permission to access the [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getAclConfig

public final AclConfig getAclConfig(GetAclConfigRequest request)

Gets the [AclConfig][google.cloud.discoveryengine.v1alpha.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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getAclConfigCallable

public final com.google.api.gax.rpc.UnaryCallable<GetAclConfigRequest,AclConfig> getAclConfigCallable()

Gets the [AclConfig][google.cloud.discoveryengine.v1alpha.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();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException