Class BinauthzManagementServiceV1Client (1.46.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

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

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

GetPolicy

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.

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

  • getPolicy(Service.GetPolicyRequest request)

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

  • getPolicy(PolicyName name)

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

  • getPolicyCallable()

UpdatePolicy

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.

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

  • updatePolicy(Service.UpdatePolicyRequest request)

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

  • updatePolicy(Resources.Policy policy)

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

  • updatePolicyCallable()

CreateAttestor

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.

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

  • createAttestor(Service.CreateAttestorRequest request)

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

  • createAttestor(ProjectName parent, String attestorId, Resources.Attestor attestor)

  • createAttestor(String parent, String attestorId, Resources.Attestor attestor)

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

  • createAttestorCallable()

GetAttestor

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

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

  • getAttestor(Service.GetAttestorRequest request)

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

  • getAttestor(AttestorName name)

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

  • getAttestorCallable()

UpdateAttestor

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

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

  • updateAttestor(Service.UpdateAttestorRequest request)

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

  • updateAttestor(Resources.Attestor attestor)

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

  • updateAttestorCallable()

ListAttestors

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

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

  • listAttestors(Service.ListAttestorsRequest request)

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

  • listAttestors(ProjectName parent)

  • listAttestors(String parent)

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

  • listAttestorsPagedCallable()

  • listAttestorsCallable()

DeleteAttestor

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

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

  • deleteAttestor(Service.DeleteAttestorRequest request)

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

  • deleteAttestor(AttestorName name)

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

  • deleteAttestorCallable()

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 BinauthzManagementServiceV1Settings 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
 BinauthzManagementServiceV1Settings binauthzManagementServiceV1Settings =
     BinauthzManagementServiceV1Settings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create(binauthzManagementServiceV1Settings);

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
 BinauthzManagementServiceV1Settings binauthzManagementServiceV1Settings =
     BinauthzManagementServiceV1Settings.newBuilder().setEndpoint(myEndpoint).build();
 BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create(binauthzManagementServiceV1Settings);

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
 BinauthzManagementServiceV1Settings binauthzManagementServiceV1Settings =
     BinauthzManagementServiceV1Settings.newHttpJsonBuilder().build();
 BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create(binauthzManagementServiceV1Settings);

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

Inheritance

java.lang.Object > BinauthzManagementServiceV1Client

Static Methods

create()

public static final BinauthzManagementServiceV1Client create()

Constructs an instance of BinauthzManagementServiceV1Client with default settings.

Returns
Type Description
BinauthzManagementServiceV1Client
Exceptions
Type Description
IOException

create(BinauthzManagementServiceV1Settings settings)

public static final BinauthzManagementServiceV1Client create(BinauthzManagementServiceV1Settings settings)

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

create(BinauthzManagementServiceV1Stub stub)

public static final BinauthzManagementServiceV1Client create(BinauthzManagementServiceV1Stub stub)

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

Parameter
Name Description
stub BinauthzManagementServiceV1Stub
Returns
Type Description
BinauthzManagementServiceV1Client

Constructors

BinauthzManagementServiceV1Client(BinauthzManagementServiceV1Settings settings)

protected BinauthzManagementServiceV1Client(BinauthzManagementServiceV1Settings settings)

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

BinauthzManagementServiceV1Client(BinauthzManagementServiceV1Stub stub)

protected BinauthzManagementServiceV1Client(BinauthzManagementServiceV1Stub stub)
Parameter
Name Description
stub BinauthzManagementServiceV1Stub

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(ProjectName parent, String attestorId, Resources.Attestor attestor)

public final Resources.Attestor createAttestor(ProjectName parent, String attestorId, Resources.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String attestorId = "attestorId2055733027";
   Resources.Attestor attestor = Resources.Attestor.newBuilder().build();
   Resources.Attestor response =
       binauthzManagementServiceV1Client.createAttestor(parent, attestorId, attestor);
 }
Parameters
Name Description
parent ProjectName

Required. The parent of this attestor.
attestorId String

Required. The attestors ID.
attestor Resources.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
Resources.Attestor

createAttestor(Service.CreateAttestorRequest request)

public final Resources.Attestor createAttestor(Service.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.CreateAttestorRequest request =
       Service.CreateAttestorRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setAttestorId("attestorId2055733027")
           .setAttestor(Resources.Attestor.newBuilder().build())
           .build();
   Resources.Attestor response = binauthzManagementServiceV1Client.createAttestor(request);
 }
Parameter
Name Description
request Service.CreateAttestorRequest

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

createAttestor(String parent, String attestorId, Resources.Attestor attestor)

public final Resources.Attestor createAttestor(String parent, String attestorId, Resources.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   String attestorId = "attestorId2055733027";
   Resources.Attestor attestor = Resources.Attestor.newBuilder().build();
   Resources.Attestor response =
       binauthzManagementServiceV1Client.createAttestor(parent, attestorId, attestor);
 }
Parameters
Name Description
parent String

Required. The parent of this attestor.
attestorId String

Required. The attestors ID.
attestor Resources.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
Resources.Attestor

createAttestorCallable()

public final UnaryCallable<Service.CreateAttestorRequest,Resources.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.CreateAttestorRequest request =
       Service.CreateAttestorRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setAttestorId("attestorId2055733027")
           .setAttestor(Resources.Attestor.newBuilder().build())
           .build();
   ApiFuture<Resources.Attestor> future =
       binauthzManagementServiceV1Client.createAttestorCallable().futureCall(request);
   // Do something.
   Resources.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   AttestorName name = AttestorName.of("[PROJECT]", "[ATTESTOR]");
   binauthzManagementServiceV1Client.deleteAttestor(name);
 }
Parameter
Name Description
name AttestorName

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

deleteAttestor(Service.DeleteAttestorRequest request)

public final void deleteAttestor(Service.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.DeleteAttestorRequest request =
       Service.DeleteAttestorRequest.newBuilder()
           .setName(AttestorName.of("[PROJECT]", "[ATTESTOR]").toString())
           .build();
   binauthzManagementServiceV1Client.deleteAttestor(request);
 }
Parameter
Name Description
request Service.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   String name = AttestorName.of("[PROJECT]", "[ATTESTOR]").toString();
   binauthzManagementServiceV1Client.deleteAttestor(name);
 }
Parameter
Name Description
name String

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

deleteAttestorCallable()

public final UnaryCallable<Service.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.DeleteAttestorRequest request =
       Service.DeleteAttestorRequest.newBuilder()
           .setName(AttestorName.of("[PROJECT]", "[ATTESTOR]").toString())
           .build();
   ApiFuture<Empty> future =
       binauthzManagementServiceV1Client.deleteAttestorCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteAttestorRequest,Empty>

getAttestor(AttestorName name)

public final Resources.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   AttestorName name = AttestorName.of("[PROJECT]", "[ATTESTOR]");
   Resources.Attestor response = binauthzManagementServiceV1Client.getAttestor(name);
 }
Parameter
Name Description
name AttestorName

Required. The name of the attestor to retrieve, in the format projects/*/attestors/*.
Returns
Type Description
Resources.Attestor

getAttestor(Service.GetAttestorRequest request)

public final Resources.Attestor getAttestor(Service.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.GetAttestorRequest request =
       Service.GetAttestorRequest.newBuilder()
           .setName(AttestorName.of("[PROJECT]", "[ATTESTOR]").toString())
           .build();
   Resources.Attestor response = binauthzManagementServiceV1Client.getAttestor(request);
 }
Parameter
Name Description
request Service.GetAttestorRequest

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

getAttestor(String name)

public final Resources.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   String name = AttestorName.of("[PROJECT]", "[ATTESTOR]").toString();
   Resources.Attestor response = binauthzManagementServiceV1Client.getAttestor(name);
 }
Parameter
Name Description
name String

Required. The name of the attestor to retrieve, in the format projects/*/attestors/*.
Returns
Type Description
Resources.Attestor

getAttestorCallable()

public final UnaryCallable<Service.GetAttestorRequest,Resources.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.GetAttestorRequest request =
       Service.GetAttestorRequest.newBuilder()
           .setName(AttestorName.of("[PROJECT]", "[ATTESTOR]").toString())
           .build();
   ApiFuture<Resources.Attestor> future =
       binauthzManagementServiceV1Client.getAttestorCallable().futureCall(request);
   // Do something.
   Resources.Attestor response = future.get();
 }
Returns
Type Description
UnaryCallable<GetAttestorRequest,Attestor>

getPolicy(PolicyName name)

public final Resources.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   PolicyName name = PolicyName.ofProjectName("[PROJECT]");
   Resources.Policy response = binauthzManagementServiceV1Client.getPolicy(name);
 }
Parameter
Name Description
name PolicyName

Required. The resource name of the policy to retrieve, in the format projects/*/policy.
Returns
Type Description
Resources.Policy

getPolicy(Service.GetPolicyRequest request)

public final Resources.Policy getPolicy(Service.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.GetPolicyRequest request =
       Service.GetPolicyRequest.newBuilder()
           .setName(PolicyName.ofProjectName("[PROJECT]").toString())
           .build();
   Resources.Policy response = binauthzManagementServiceV1Client.getPolicy(request);
 }
Parameter
Name Description
request Service.GetPolicyRequest

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

getPolicy(String name)

public final Resources.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   String name = PolicyName.ofProjectName("[PROJECT]").toString();
   Resources.Policy response = binauthzManagementServiceV1Client.getPolicy(name);
 }
Parameter
Name Description
name String

Required. The resource name of the policy to retrieve, in the format projects/*/policy.
Returns
Type Description
Resources.Policy

getPolicyCallable()

public final UnaryCallable<Service.GetPolicyRequest,Resources.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.GetPolicyRequest request =
       Service.GetPolicyRequest.newBuilder()
           .setName(PolicyName.ofProjectName("[PROJECT]").toString())
           .build();
   ApiFuture<Resources.Policy> future =
       binauthzManagementServiceV1Client.getPolicyCallable().futureCall(request);
   // Do something.
   Resources.Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<GetPolicyRequest,Policy>

getSettings()

public final BinauthzManagementServiceV1Settings getSettings()
Returns
Type Description
BinauthzManagementServiceV1Settings

getStub()

public BinauthzManagementServiceV1Stub getStub()
Returns
Type Description
BinauthzManagementServiceV1Stub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listAttestors(ProjectName parent)

public final BinauthzManagementServiceV1Client.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Resources.Attestor element :
       binauthzManagementServiceV1Client.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
BinauthzManagementServiceV1Client.ListAttestorsPagedResponse

listAttestors(Service.ListAttestorsRequest request)

public final BinauthzManagementServiceV1Client.ListAttestorsPagedResponse listAttestors(Service.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.ListAttestorsRequest request =
       Service.ListAttestorsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Resources.Attestor element :
       binauthzManagementServiceV1Client.listAttestors(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request Service.ListAttestorsRequest

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

listAttestors(String parent)

public final BinauthzManagementServiceV1Client.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (Resources.Attestor element :
       binauthzManagementServiceV1Client.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
BinauthzManagementServiceV1Client.ListAttestorsPagedResponse

listAttestorsCallable()

public final UnaryCallable<Service.ListAttestorsRequest,Service.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.ListAttestorsRequest request =
       Service.ListAttestorsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     Service.ListAttestorsResponse response =
         binauthzManagementServiceV1Client.listAttestorsCallable().call(request);
     for (Resources.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<Service.ListAttestorsRequest,BinauthzManagementServiceV1Client.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.ListAttestorsRequest request =
       Service.ListAttestorsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Resources.Attestor> future =
       binauthzManagementServiceV1Client.listAttestorsPagedCallable().futureCall(request);
   // Do something.
   for (Resources.Attestor element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListAttestorsRequest,ListAttestorsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAttestor(Resources.Attestor attestor)

public final Resources.Attestor updateAttestor(Resources.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Resources.Attestor attestor = Resources.Attestor.newBuilder().build();
   Resources.Attestor response = binauthzManagementServiceV1Client.updateAttestor(attestor);
 }
Parameter
Name Description
attestor Resources.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
Resources.Attestor

updateAttestor(Service.UpdateAttestorRequest request)

public final Resources.Attestor updateAttestor(Service.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.UpdateAttestorRequest request =
       Service.UpdateAttestorRequest.newBuilder()
           .setAttestor(Resources.Attestor.newBuilder().build())
           .build();
   Resources.Attestor response = binauthzManagementServiceV1Client.updateAttestor(request);
 }
Parameter
Name Description
request Service.UpdateAttestorRequest

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

updateAttestorCallable()

public final UnaryCallable<Service.UpdateAttestorRequest,Resources.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.UpdateAttestorRequest request =
       Service.UpdateAttestorRequest.newBuilder()
           .setAttestor(Resources.Attestor.newBuilder().build())
           .build();
   ApiFuture<Resources.Attestor> future =
       binauthzManagementServiceV1Client.updateAttestorCallable().futureCall(request);
   // Do something.
   Resources.Attestor response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateAttestorRequest,Attestor>

updatePolicy(Resources.Policy policy)

public final Resources.Policy updatePolicy(Resources.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Resources.Policy policy = Resources.Policy.newBuilder().build();
   Resources.Policy response = binauthzManagementServiceV1Client.updatePolicy(policy);
 }
Parameter
Name Description
policy Resources.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
Resources.Policy

updatePolicy(Service.UpdatePolicyRequest request)

public final Resources.Policy updatePolicy(Service.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.UpdatePolicyRequest request =
       Service.UpdatePolicyRequest.newBuilder()
           .setPolicy(Resources.Policy.newBuilder().build())
           .build();
   Resources.Policy response = binauthzManagementServiceV1Client.updatePolicy(request);
 }
Parameter
Name Description
request Service.UpdatePolicyRequest

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

updatePolicyCallable()

public final UnaryCallable<Service.UpdatePolicyRequest,Resources.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 (BinauthzManagementServiceV1Client binauthzManagementServiceV1Client =
     BinauthzManagementServiceV1Client.create()) {
   Service.UpdatePolicyRequest request =
       Service.UpdatePolicyRequest.newBuilder()
           .setPolicy(Resources.Policy.newBuilder().build())
           .build();
   ApiFuture<Resources.Policy> future =
       binauthzManagementServiceV1Client.updatePolicyCallable().futureCall(request);
   // Do something.
   Resources.Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdatePolicyRequest,Policy>