com.google.protos.google.cloud.binaryauthorization.v1

Class SystemPolicyV1Client

java.lang.Object

com.google.protos.google.cloud.binaryauthorization.v1.SystemPolicyV1Client

All Implemented Interfaces:

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

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

Service Description: API for working with the system policy.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SystemPolicyV1Client systemPolicyV1Client = SystemPolicyV1Client.create()) {
   PolicyName name = PolicyName.ofLocationName("[LOCATION]");
   Resources.Policy response = systemPolicyV1Client.getSystemPolicy(name);
 }
 

Note: close() needs to be called on the SystemPolicyV1Client object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

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

This class can be customized by passing in a custom instance of SystemPolicyV1Settings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 SystemPolicyV1Settings systemPolicyV1Settings =
     SystemPolicyV1Settings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SystemPolicyV1Client systemPolicyV1Client = SystemPolicyV1Client.create(systemPolicyV1Settings);
 

To customize the endpoint:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 SystemPolicyV1Settings systemPolicyV1Settings =
     SystemPolicyV1Settings.newBuilder().setEndpoint(myEndpoint).build();
 SystemPolicyV1Client systemPolicyV1Client = SystemPolicyV1Client.create(systemPolicyV1Settings);
 

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

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 SystemPolicyV1Settings systemPolicyV1Settings =
     SystemPolicyV1Settings.newBuilder()
         .setTransportChannelProvider(
             SystemPolicyV1Settings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 SystemPolicyV1Client systemPolicyV1Client = SystemPolicyV1Client.create(systemPolicyV1Settings);
 

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SystemPolicyV1Client(SystemPolicyV1Settings settings) Constructs an instance of SystemPolicyV1Client, using the given settings.
protected	SystemPolicyV1Client(SystemPolicyV1Stub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static SystemPolicyV1Client	create() Constructs an instance of SystemPolicyV1Client with default settings.
static SystemPolicyV1Client	create(SystemPolicyV1Settings settings) Constructs an instance of SystemPolicyV1Client, using the given settings.
static SystemPolicyV1Client	create(SystemPolicyV1Stub stub) Constructs an instance of SystemPolicyV1Client, using the given stub for making calls.
SystemPolicyV1Settings	getSettings()
SystemPolicyV1Stub	getStub()
Resources.Policy	getSystemPolicy(PolicyName name) Gets the current system policy in the specified location.
Resources.Policy	getSystemPolicy(Service.GetSystemPolicyRequest request) Gets the current system policy in the specified location.
Resources.Policy	getSystemPolicy(String name) Gets the current system policy in the specified location.
com.google.api.gax.rpc.UnaryCallable<Service.GetSystemPolicyRequest,Resources.Policy>	getSystemPolicyCallable() Gets the current system policy in the specified location.
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemPolicyV1Client

protected SystemPolicyV1Client(SystemPolicyV1Settings settings)
                        throws IOException

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

SystemPolicyV1Client

protected SystemPolicyV1Client(SystemPolicyV1Stub stub)

Method Detail

create

public static final SystemPolicyV1Client create()
                                         throws IOException

Constructs an instance of SystemPolicyV1Client with default settings.

Throws:

IOException

create

public static final SystemPolicyV1Client create(SystemPolicyV1Settings settings)
                                         throws IOException

Constructs an instance of SystemPolicyV1Client, 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 SystemPolicyV1Client create(SystemPolicyV1Stub stub)

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

getSettings

public final SystemPolicyV1Settings getSettings()

getStub

public SystemPolicyV1Stub getStub()

getSystemPolicy

public final Resources.Policy getSystemPolicy(PolicyName name)

Gets the current system policy in the specified location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SystemPolicyV1Client systemPolicyV1Client = SystemPolicyV1Client.create()) {
   PolicyName name = PolicyName.ofLocationName("[LOCATION]");
   Resources.Policy response = systemPolicyV1Client.getSystemPolicy(name);
 }
 

Parameters:

name - Required. The resource name, in the format `locations/*/policy`. Note that the system policy is not associated with a project.

Throws:

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

getSystemPolicy

public final Resources.Policy getSystemPolicy(String name)

Gets the current system policy in the specified location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SystemPolicyV1Client systemPolicyV1Client = SystemPolicyV1Client.create()) {
   String name = PolicyName.ofProjectName("[PROJECT]").toString();
   Resources.Policy response = systemPolicyV1Client.getSystemPolicy(name);
 }
 

Parameters:

name - Required. The resource name, in the format `locations/*/policy`. Note that the system policy is not associated with a project.

Throws:

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

getSystemPolicy

public final Resources.Policy getSystemPolicy(Service.GetSystemPolicyRequest request)

Gets the current system policy in the specified location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SystemPolicyV1Client systemPolicyV1Client = SystemPolicyV1Client.create()) {
   Service.GetSystemPolicyRequest request =
       Service.GetSystemPolicyRequest.newBuilder()
           .setName(PolicyName.ofLocationName("[LOCATION]").toString())
           .build();
   Resources.Policy response = systemPolicyV1Client.getSystemPolicy(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

getSystemPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<Service.GetSystemPolicyRequest,Resources.Policy> getSystemPolicyCallable()

Gets the current system policy in the specified location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SystemPolicyV1Client systemPolicyV1Client = SystemPolicyV1Client.create()) {
   Service.GetSystemPolicyRequest request =
       Service.GetSystemPolicyRequest.newBuilder()
           .setName(PolicyName.ofLocationName("[LOCATION]").toString())
           .build();
   ApiFuture<Resources.Policy> future =
       systemPolicyV1Client.getSystemPolicyCallable().futureCall(request);
   // Do something.
   Resources.Policy 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