Class BinauthzManagementServiceV1Beta1Client (1.6.0)

Version 1.6.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

public class BinauthzManagementServiceV1Beta1Client implements BackgroundResource

Service Description: Google Cloud Management Service for Binary Authorization admission policies and attestation authorities.

This API implements a REST model with the following objects:

• Policy
• Attestor

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   PolicyName name = PolicyName.ofProjectName("[PROJECT]");
   Policy response = binauthzManagementServiceV1Beta1Client.getPolicy(name);
 }
 

Note: close() needs to be called on the BinauthzManagementServiceV1Beta1Client 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 BinauthzManagementServiceV1Beta1Settings 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
 BinauthzManagementServiceV1Beta1Settings binauthzManagementServiceV1Beta1Settings =
     BinauthzManagementServiceV1Beta1Settings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create(binauthzManagementServiceV1Beta1Settings);
 

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
 BinauthzManagementServiceV1Beta1Settings binauthzManagementServiceV1Beta1Settings =
     BinauthzManagementServiceV1Beta1Settings.newBuilder().setEndpoint(myEndpoint).build();
 BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create(binauthzManagementServiceV1Beta1Settings);
 

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
 BinauthzManagementServiceV1Beta1Settings binauthzManagementServiceV1Beta1Settings =
     BinauthzManagementServiceV1Beta1Settings.newHttpJsonBuilder().build();
 BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create(binauthzManagementServiceV1Beta1Settings);
 

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

Inheritance

java.lang.Object > BinauthzManagementServiceV1Beta1Client

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final BinauthzManagementServiceV1Beta1Client create()

Constructs an instance of BinauthzManagementServiceV1Beta1Client with default settings.

Returns

Type	Description
BinauthzManagementServiceV1Beta1Client

Exceptions

Type	Description
IOException

create(BinauthzManagementServiceV1Beta1Settings settings)

public static final BinauthzManagementServiceV1Beta1Client create(BinauthzManagementServiceV1Beta1Settings settings)

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

Returns

Type	Description
BinauthzManagementServiceV1Beta1Client

Exceptions

Type	Description
IOException

create(BinauthzManagementServiceV1Beta1Stub stub)

public static final BinauthzManagementServiceV1Beta1Client create(BinauthzManagementServiceV1Beta1Stub stub)

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

Parameter

Name	Description
stub	BinauthzManagementServiceV1Beta1Stub

Returns

Type	Description
BinauthzManagementServiceV1Beta1Client

Constructors

BinauthzManagementServiceV1Beta1Client(BinauthzManagementServiceV1Beta1Settings settings)

protected BinauthzManagementServiceV1Beta1Client(BinauthzManagementServiceV1Beta1Settings settings)

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

BinauthzManagementServiceV1Beta1Client(BinauthzManagementServiceV1Beta1Stub stub)

protected BinauthzManagementServiceV1Beta1Client(BinauthzManagementServiceV1Beta1Stub stub)

Parameter

Name	Description
stub	BinauthzManagementServiceV1Beta1Stub

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

createAttestor(CreateAttestorRequest request)

public final Attestor createAttestor(CreateAttestorRequest request)

Creates an attestor, and returns a copy of the new attestor. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the attestor already exists.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   CreateAttestorRequest request =
       CreateAttestorRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setAttestorId("attestorId2055733027")
           .setAttestor(Attestor.newBuilder().build())
           .build();
   Attestor response = binauthzManagementServiceV1Beta1Client.createAttestor(request);
 }
 

Parameter

Name	Description
request	CreateAttestorRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Attestor

createAttestor(ProjectName parent, String attestorId, Attestor attestor)

public final Attestor createAttestor(ProjectName parent, String attestorId, Attestor attestor)

Creates an attestor, and returns a copy of the new attestor. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the attestor already exists.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String attestorId = "attestorId2055733027";
   Attestor attestor = Attestor.newBuilder().build();
   Attestor response =
       binauthzManagementServiceV1Beta1Client.createAttestor(parent, attestorId, attestor);
 }
 

Parameters

Name	Description
parent	ProjectName Required. The parent of this attestor.
attestorId	String Required. The attestors ID.
attestor	Attestor Required. The initial attestor value. The service will overwrite the attestor name field with the resource name, in the format projects/*/attestors/*.

Returns

Type	Description
Attestor

createAttestor(String parent, String attestorId, Attestor attestor)

public final Attestor createAttestor(String parent, String attestorId, Attestor attestor)

Creates an attestor, and returns a copy of the new attestor. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the attestor already exists.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   String attestorId = "attestorId2055733027";
   Attestor attestor = Attestor.newBuilder().build();
   Attestor response =
       binauthzManagementServiceV1Beta1Client.createAttestor(parent, attestorId, attestor);
 }
 

Parameters

Name	Description
parent	String Required. The parent of this attestor.
attestorId	String Required. The attestors ID.
attestor	Attestor Required. The initial attestor value. The service will overwrite the attestor name field with the resource name, in the format projects/*/attestors/*.

Returns

Type	Description
Attestor

createAttestorCallable()

public final UnaryCallable<CreateAttestorRequest,Attestor> createAttestorCallable()

Creates an attestor, and returns a copy of the new attestor. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the attestor already exists.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   CreateAttestorRequest request =
       CreateAttestorRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setAttestorId("attestorId2055733027")
           .setAttestor(Attestor.newBuilder().build())
           .build();
   ApiFuture<Attestor> future =
       binauthzManagementServiceV1Beta1Client.createAttestorCallable().futureCall(request);
   // Do something.
   Attestor response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<CreateAttestorRequest,Attestor>

deleteAttestor(AttestorName name)

public final void deleteAttestor(AttestorName name)

Deletes an attestor. Returns NOT_FOUND if the attestor does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   AttestorName name = AttestorName.of("[PROJECT]", "[ATTESTOR]");
   binauthzManagementServiceV1Beta1Client.deleteAttestor(name);
 }
 

Parameter

Name	Description
name	AttestorName Required. The name of the attestors to delete, in the format projects/*/attestors/*.

deleteAttestor(DeleteAttestorRequest request)

public final void deleteAttestor(DeleteAttestorRequest request)

Deletes an attestor. Returns NOT_FOUND if the attestor does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   DeleteAttestorRequest request =
       DeleteAttestorRequest.newBuilder()
           .setName(AttestorName.of("[PROJECT]", "[ATTESTOR]").toString())
           .build();
   binauthzManagementServiceV1Beta1Client.deleteAttestor(request);
 }
 

Parameter

Name	Description
request	DeleteAttestorRequest The request object containing all of the parameters for the API call.

deleteAttestor(String name)

public final void deleteAttestor(String name)

Deletes an attestor. Returns NOT_FOUND if the attestor does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   String name = AttestorName.of("[PROJECT]", "[ATTESTOR]").toString();
   binauthzManagementServiceV1Beta1Client.deleteAttestor(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the attestors to delete, in the format projects/*/attestors/*.

deleteAttestorCallable()

public final UnaryCallable<DeleteAttestorRequest,Empty> deleteAttestorCallable()

Deletes an attestor. Returns NOT_FOUND if the attestor does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   DeleteAttestorRequest request =
       DeleteAttestorRequest.newBuilder()
           .setName(AttestorName.of("[PROJECT]", "[ATTESTOR]").toString())
           .build();
   ApiFuture<Empty> future =
       binauthzManagementServiceV1Beta1Client.deleteAttestorCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteAttestorRequest,Empty>

getAttestor(AttestorName name)

public final Attestor getAttestor(AttestorName name)

Gets an attestor. Returns NOT_FOUND if the attestor does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   AttestorName name = AttestorName.of("[PROJECT]", "[ATTESTOR]");
   Attestor response = binauthzManagementServiceV1Beta1Client.getAttestor(name);
 }
 

Parameter

Name	Description
name	AttestorName Required. The name of the attestor to retrieve, in the format projects/*/attestors/*.

Returns

Type	Description
Attestor

getAttestor(GetAttestorRequest request)

public final Attestor getAttestor(GetAttestorRequest request)

Gets an attestor. Returns NOT_FOUND if the attestor does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   GetAttestorRequest request =
       GetAttestorRequest.newBuilder()
           .setName(AttestorName.of("[PROJECT]", "[ATTESTOR]").toString())
           .build();
   Attestor response = binauthzManagementServiceV1Beta1Client.getAttestor(request);
 }
 

Parameter

Name	Description
request	GetAttestorRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Attestor

getAttestor(String name)

public final Attestor getAttestor(String name)

Gets an attestor. Returns NOT_FOUND if the attestor does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   String name = AttestorName.of("[PROJECT]", "[ATTESTOR]").toString();
   Attestor response = binauthzManagementServiceV1Beta1Client.getAttestor(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the attestor to retrieve, in the format projects/*/attestors/*.

Returns

Type	Description
Attestor

getAttestorCallable()

public final UnaryCallable<GetAttestorRequest,Attestor> getAttestorCallable()

Gets an attestor. Returns NOT_FOUND if the attestor does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   GetAttestorRequest request =
       GetAttestorRequest.newBuilder()
           .setName(AttestorName.of("[PROJECT]", "[ATTESTOR]").toString())
           .build();
   ApiFuture<Attestor> future =
       binauthzManagementServiceV1Beta1Client.getAttestorCallable().futureCall(request);
   // Do something.
   Attestor response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetAttestorRequest,Attestor>

getPolicy(GetPolicyRequest request)

public final Policy getPolicy(GetPolicyRequest request)

A policy specifies the attestors that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy.

Gets the policy for this project. Returns a default policy if the project does not have one.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   GetPolicyRequest request =
       GetPolicyRequest.newBuilder()
           .setName(PolicyName.ofProjectName("[PROJECT]").toString())
           .build();
   Policy response = binauthzManagementServiceV1Beta1Client.getPolicy(request);
 }
 

Parameter

Name	Description
request	GetPolicyRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Policy

getPolicy(PolicyName name)

public final Policy getPolicy(PolicyName name)

A policy specifies the attestors that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy.

Gets the policy for this project. Returns a default policy if the project does not have one.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   PolicyName name = PolicyName.ofProjectName("[PROJECT]");
   Policy response = binauthzManagementServiceV1Beta1Client.getPolicy(name);
 }
 

Parameter

Name	Description
name	PolicyName Required. The resource name of the policy to retrieve, in the format projects/*/policy.

Returns

Type	Description
Policy

getPolicy(String name)

public final Policy getPolicy(String name)

A policy specifies the attestors that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy.

Gets the policy for this project. Returns a default policy if the project does not have one.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   String name = PolicyName.ofProjectName("[PROJECT]").toString();
   Policy response = binauthzManagementServiceV1Beta1Client.getPolicy(name);
 }
 

Parameter

Name	Description
name	String Required. The resource name of the policy to retrieve, in the format projects/*/policy.

Returns

Type	Description
Policy

getPolicyCallable()

public final UnaryCallable<GetPolicyRequest,Policy> getPolicyCallable()

A policy specifies the attestors that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy.

Gets the policy for this project. Returns a default policy if the project does not have one.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   GetPolicyRequest request =
       GetPolicyRequest.newBuilder()
           .setName(PolicyName.ofProjectName("[PROJECT]").toString())
           .build();
   ApiFuture<Policy> future =
       binauthzManagementServiceV1Beta1Client.getPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetPolicyRequest,Policy>

getSettings()

public final BinauthzManagementServiceV1Beta1Settings getSettings()

Returns

Type	Description
BinauthzManagementServiceV1Beta1Settings

getStub()

public BinauthzManagementServiceV1Beta1Stub getStub()

Returns

Type	Description
BinauthzManagementServiceV1Beta1Stub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listAttestors(ListAttestorsRequest request)

public final BinauthzManagementServiceV1Beta1Client.ListAttestorsPagedResponse listAttestors(ListAttestorsRequest request)

Lists attestors. Returns INVALID_ARGUMENT if the project does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   ListAttestorsRequest request =
       ListAttestorsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Attestor element :
       binauthzManagementServiceV1Beta1Client.listAttestors(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListAttestorsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
BinauthzManagementServiceV1Beta1Client.ListAttestorsPagedResponse

listAttestors(ProjectName parent)

public final BinauthzManagementServiceV1Beta1Client.ListAttestorsPagedResponse listAttestors(ProjectName parent)

Lists attestors. Returns INVALID_ARGUMENT if the project does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Attestor element :
       binauthzManagementServiceV1Beta1Client.listAttestors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	ProjectName Required. The resource name of the project associated with the attestors, in the format projects/*.

Returns

Type	Description
BinauthzManagementServiceV1Beta1Client.ListAttestorsPagedResponse

listAttestors(String parent)

public final BinauthzManagementServiceV1Beta1Client.ListAttestorsPagedResponse listAttestors(String parent)

Lists attestors. Returns INVALID_ARGUMENT if the project does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (Attestor element :
       binauthzManagementServiceV1Beta1Client.listAttestors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String Required. The resource name of the project associated with the attestors, in the format projects/*.

Returns

Type	Description
BinauthzManagementServiceV1Beta1Client.ListAttestorsPagedResponse

listAttestorsCallable()

public final UnaryCallable<ListAttestorsRequest,ListAttestorsResponse> listAttestorsCallable()

Lists attestors. Returns INVALID_ARGUMENT if the project does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   ListAttestorsRequest request =
       ListAttestorsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAttestorsResponse response =
         binauthzManagementServiceV1Beta1Client.listAttestorsCallable().call(request);
     for (Attestor element : response.getAttestorsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListAttestorsRequest,ListAttestorsResponse>

listAttestorsPagedCallable()

public final UnaryCallable<ListAttestorsRequest,BinauthzManagementServiceV1Beta1Client.ListAttestorsPagedResponse> listAttestorsPagedCallable()

Lists attestors. Returns INVALID_ARGUMENT if the project does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   ListAttestorsRequest request =
       ListAttestorsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Attestor> future =
       binauthzManagementServiceV1Beta1Client.listAttestorsPagedCallable().futureCall(request);
   // Do something.
   for (Attestor element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListAttestorsRequest,ListAttestorsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAttestor(Attestor attestor)

public final Attestor updateAttestor(Attestor attestor)

Updates an attestor. Returns NOT_FOUND if the attestor does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   Attestor attestor = Attestor.newBuilder().build();
   Attestor response = binauthzManagementServiceV1Beta1Client.updateAttestor(attestor);
 }
 

Parameter

Name	Description
attestor	Attestor Required. The updated attestor value. The service will overwrite the attestor name field with the resource name in the request URL, in the format projects/*/attestors/*.

Returns

Type	Description
Attestor

updateAttestor(UpdateAttestorRequest request)

public final Attestor updateAttestor(UpdateAttestorRequest request)

Updates an attestor. Returns NOT_FOUND if the attestor does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   UpdateAttestorRequest request =
       UpdateAttestorRequest.newBuilder().setAttestor(Attestor.newBuilder().build()).build();
   Attestor response = binauthzManagementServiceV1Beta1Client.updateAttestor(request);
 }
 

Parameter

Name	Description
request	UpdateAttestorRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Attestor

updateAttestorCallable()

public final UnaryCallable<UpdateAttestorRequest,Attestor> updateAttestorCallable()

Updates an attestor. Returns NOT_FOUND if the attestor does not exist.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   UpdateAttestorRequest request =
       UpdateAttestorRequest.newBuilder().setAttestor(Attestor.newBuilder().build()).build();
   ApiFuture<Attestor> future =
       binauthzManagementServiceV1Beta1Client.updateAttestorCallable().futureCall(request);
   // Do something.
   Attestor response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdateAttestorRequest,Attestor>

updatePolicy(Policy policy)

public final Policy updatePolicy(Policy policy)

Creates or updates a project's policy, and returns a copy of the new policy. A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   Policy policy = Policy.newBuilder().build();
   Policy response = binauthzManagementServiceV1Beta1Client.updatePolicy(policy);
 }
 

Parameter

Name	Description
policy	Policy Required. A new or updated policy value. The service will overwrite the policy name field with the resource name in the request URL, in the format projects/*/policy.

Returns

Type	Description
Policy

updatePolicy(UpdatePolicyRequest request)

public final Policy updatePolicy(UpdatePolicyRequest request)

Creates or updates a project's policy, and returns a copy of the new policy. A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   UpdatePolicyRequest request =
       UpdatePolicyRequest.newBuilder().setPolicy(Policy.newBuilder().build()).build();
   Policy response = binauthzManagementServiceV1Beta1Client.updatePolicy(request);
 }
 

Parameter

Name	Description
request	UpdatePolicyRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Policy

updatePolicyCallable()

public final UnaryCallable<UpdatePolicyRequest,Policy> updatePolicyCallable()

Creates or updates a project's policy, and returns a copy of the new policy. A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed.

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 (BinauthzManagementServiceV1Beta1Client binauthzManagementServiceV1Beta1Client =
     BinauthzManagementServiceV1Beta1Client.create()) {
   UpdatePolicyRequest request =
       UpdatePolicyRequest.newBuilder().setPolicy(Policy.newBuilder().build()).build();
   ApiFuture<Policy> future =
       binauthzManagementServiceV1Beta1Client.updatePolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdatePolicyRequest,Policy>