Class SystemPolicyV1Client (1.46.0)

Version 1.46.0

• 1.52.0 (latest)
• 1.51.0
• 1.50.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.0.6

GitHub Repository

Product Reference

REST Documentation

RPC Documentation

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

Methods

Method	Description	Method Variants
GetSystemPolicy	Gets the current system policy in the specified location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getSystemPolicy(Service.GetSystemPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getSystemPolicy(PolicyName name) getSystemPolicy(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. getSystemPolicyCallable()

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 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
 SystemPolicyV1Settings systemPolicyV1Settings =
     SystemPolicyV1Settings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SystemPolicyV1Client systemPolicyV1Client = SystemPolicyV1Client.create(systemPolicyV1Settings);
 

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
 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 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
 SystemPolicyV1Settings systemPolicyV1Settings =
     SystemPolicyV1Settings.newHttpJsonBuilder().build();
 SystemPolicyV1Client systemPolicyV1Client = SystemPolicyV1Client.create(systemPolicyV1Settings);
 

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

Inheritance

java.lang.Object > SystemPolicyV1Client

Static Methods

create()

public static final SystemPolicyV1Client create()

Constructs an instance of SystemPolicyV1Client with default settings.

Returns
Type	Description
SystemPolicyV1Client

Exceptions
Type	Description
IOException

create(SystemPolicyV1Settings settings)

public static final SystemPolicyV1Client create(SystemPolicyV1Settings settings)

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.

Parameter
Name	Description
settings	SystemPolicyV1Settings

Returns
Type	Description
SystemPolicyV1Client

Exceptions
Type	Description
IOException

create(SystemPolicyV1Stub stub)

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

Parameter
Name	Description
stub	SystemPolicyV1Stub

Returns
Type	Description
SystemPolicyV1Client

Constructors

SystemPolicyV1Client(SystemPolicyV1Settings settings)

protected SystemPolicyV1Client(SystemPolicyV1Settings settings)

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.

Parameter
Name	Description
settings	SystemPolicyV1Settings

SystemPolicyV1Client(SystemPolicyV1Stub stub)

protected SystemPolicyV1Client(SystemPolicyV1Stub stub)

Parameter
Name	Description
stub	SystemPolicyV1Stub

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

getSettings()

public final SystemPolicyV1Settings getSettings()

Returns
Type	Description
SystemPolicyV1Settings

getStub()

public SystemPolicyV1Stub getStub()

Returns
Type	Description
SystemPolicyV1Stub

getSystemPolicy(PolicyName name)

public final Resources.Policy getSystemPolicy(PolicyName name)

Gets the current system policy in the specified 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 (SystemPolicyV1Client systemPolicyV1Client = SystemPolicyV1Client.create()) {
   PolicyName name = PolicyName.ofLocationName("[LOCATION]");
   Resources.Policy response = systemPolicyV1Client.getSystemPolicy(name);
 }
 

Parameter
Name	Description
name	PolicyName Required. The resource name, in the format locations/*/policy. Note that the system policy is not associated with a project.

Returns
Type	Description
Resources.Policy

getSystemPolicy(Service.GetSystemPolicyRequest request)

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 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 (SystemPolicyV1Client systemPolicyV1Client = SystemPolicyV1Client.create()) {
   Service.GetSystemPolicyRequest request =
       Service.GetSystemPolicyRequest.newBuilder()
           .setName(PolicyName.ofLocationName("[LOCATION]").toString())
           .build();
   Resources.Policy response = systemPolicyV1Client.getSystemPolicy(request);
 }
 

Parameter
Name	Description
request	Service.GetSystemPolicyRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Resources.Policy

getSystemPolicy(String name)

public final Resources.Policy getSystemPolicy(String name)

Gets the current system policy in the specified 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 (SystemPolicyV1Client systemPolicyV1Client = SystemPolicyV1Client.create()) {
   String name = PolicyName.ofProjectName("[PROJECT]").toString();
   Resources.Policy response = systemPolicyV1Client.getSystemPolicy(name);
 }
 

Parameter
Name	Description
name	String Required. The resource name, in the format locations/*/policy. Note that the system policy is not associated with a project.

Returns
Type	Description
Resources.Policy

getSystemPolicyCallable()

public final UnaryCallable<Service.GetSystemPolicyRequest,Resources.Policy> getSystemPolicyCallable()

Gets the current system policy in the specified 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 (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();
 }
 

Returns
Type	Description
UnaryCallable<GetSystemPolicyRequest,Policy>

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()