Class BinauthzManagementServiceV1Client (1.0.6)

publicclass BinauthzManagementServiceV1ClientimplementsBackgroundResource

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:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
PolicyNamename=PolicyName.ofProjectName("[PROJECT]");
Resources.Policyresponse=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().

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 BinauthzManagementServiceV1Settings to create(). For example:

To customize credentials:


BinauthzManagementServiceV1SettingsbinauthzManagementServiceV1Settings=
BinauthzManagementServiceV1Settings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create(binauthzManagementServiceV1Settings);

To customize the endpoint:


BinauthzManagementServiceV1SettingsbinauthzManagementServiceV1Settings=
BinauthzManagementServiceV1Settings.newBuilder().setEndpoint(myEndpoint).build();
BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create(binauthzManagementServiceV1Settings);

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

Inheritance

java.lang.Object > BinauthzManagementServiceV1Client

Implements

BackgroundResource

Static Methods

create()

publicstaticfinalBinauthzManagementServiceV1Clientcreate()

Constructs an instance of BinauthzManagementServiceV1Client with default settings.

Returns
Type Description
Exceptions
Type Description

create(BinauthzManagementServiceV1Settings settings)

publicstaticfinalBinauthzManagementServiceV1Clientcreate(BinauthzManagementServiceV1Settingssettings)

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
Returns
Type Description
Exceptions
Type Description

create(BinauthzManagementServiceV1Stub stub)

publicstaticfinalBinauthzManagementServiceV1Clientcreate(BinauthzManagementServiceV1Stubstub)

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

Parameter
Name Description
Returns
Type Description

Constructors

BinauthzManagementServiceV1Client(BinauthzManagementServiceV1Settings settings)

protectedBinauthzManagementServiceV1Client(BinauthzManagementServiceV1Settingssettings)

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

BinauthzManagementServiceV1Client(BinauthzManagementServiceV1Stub stub)

protectedBinauthzManagementServiceV1Client(BinauthzManagementServiceV1Stubstub)
Parameter
Name Description

Methods

awaitTermination(long duration, TimeUnit unit)

publicbooleanawaitTermination(longduration,TimeUnitunit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
Exceptions
Type Description

close()

publicfinalvoidclose()

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

publicfinalResources.AttestorcreateAttestor(ProjectNameparent,StringattestorId,Resources.Attestorattestor)

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:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
ProjectNameparent=ProjectName.of("[PROJECT]");
StringattestorId="attestorId2055733027";
Resources.Attestorattestor=Resources.Attestor.newBuilder().build();
Resources.Attestorresponse=
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

createAttestor(Service.CreateAttestorRequest request)

publicfinalResources.AttestorcreateAttestor(Service.CreateAttestorRequestrequest)

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:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.CreateAttestorRequestrequest=
Service.CreateAttestorRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setAttestorId("attestorId2055733027")
.setAttestor(Resources.Attestor.newBuilder().build())
.build();
Resources.Attestorresponse=binauthzManagementServiceV1Client.createAttestor(request);
}
Parameter
Name Description
request Service.CreateAttestorRequest

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

Returns
Type Description

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

publicfinalResources.AttestorcreateAttestor(Stringparent,StringattestorId,Resources.Attestorattestor)

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:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Stringparent=ProjectName.of("[PROJECT]").toString();
StringattestorId="attestorId2055733027";
Resources.Attestorattestor=Resources.Attestor.newBuilder().build();
Resources.Attestorresponse=
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

createAttestorCallable()

publicfinalUnaryCallable<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:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.CreateAttestorRequestrequest=
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.Attestorresponse=future.get();
}
Returns
Type Description

deleteAttestor(AttestorName name)

publicfinalvoiddeleteAttestor(AttestorNamename)

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
AttestorNamename=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)

publicfinalvoiddeleteAttestor(Service.DeleteAttestorRequestrequest)

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.DeleteAttestorRequestrequest=
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)

publicfinalvoiddeleteAttestor(Stringname)

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Stringname=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()

publicfinalUnaryCallable<Service.DeleteAttestorRequest,Empty>deleteAttestorCallable()

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.DeleteAttestorRequestrequest=
Service.DeleteAttestorRequest.newBuilder()
.setName(AttestorName.of("[PROJECT]","[ATTESTOR]").toString())
.build();
ApiFuture<Empty>future=
binauthzManagementServiceV1Client.deleteAttestorCallable().futureCall(request);
// Do something.
future.get();
}
Returns
Type Description

getAttestor(AttestorName name)

publicfinalResources.AttestorgetAttestor(AttestorNamename)

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
AttestorNamename=AttestorName.of("[PROJECT]","[ATTESTOR]");
Resources.Attestorresponse=binauthzManagementServiceV1Client.getAttestor(name);
}
Parameter
Name Description
name AttestorName

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

Returns
Type Description

getAttestor(Service.GetAttestorRequest request)

publicfinalResources.AttestorgetAttestor(Service.GetAttestorRequestrequest)

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.GetAttestorRequestrequest=
Service.GetAttestorRequest.newBuilder()
.setName(AttestorName.of("[PROJECT]","[ATTESTOR]").toString())
.build();
Resources.Attestorresponse=binauthzManagementServiceV1Client.getAttestor(request);
}
Parameter
Name Description
request Service.GetAttestorRequest

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

Returns
Type Description

getAttestor(String name)

publicfinalResources.AttestorgetAttestor(Stringname)

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Stringname=AttestorName.of("[PROJECT]","[ATTESTOR]").toString();
Resources.Attestorresponse=binauthzManagementServiceV1Client.getAttestor(name);
}
Parameter
Name Description
name String

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

Returns
Type Description

getAttestorCallable()

publicfinalUnaryCallable<Service.GetAttestorRequest,Resources.Attestor>getAttestorCallable()

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.GetAttestorRequestrequest=
Service.GetAttestorRequest.newBuilder()
.setName(AttestorName.of("[PROJECT]","[ATTESTOR]").toString())
.build();
ApiFuture<Resources.Attestor>future=
binauthzManagementServiceV1Client.getAttestorCallable().futureCall(request);
// Do something.
Resources.Attestorresponse=future.get();
}
Returns
Type Description

getPolicy(PolicyName name)

publicfinalResources.PolicygetPolicy(PolicyNamename)

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:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
PolicyNamename=PolicyName.ofProjectName("[PROJECT]");
Resources.Policyresponse=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

getPolicy(Service.GetPolicyRequest request)

publicfinalResources.PolicygetPolicy(Service.GetPolicyRequestrequest)

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:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.GetPolicyRequestrequest=
Service.GetPolicyRequest.newBuilder()
.setName(PolicyName.ofProjectName("[PROJECT]").toString())
.build();
Resources.Policyresponse=binauthzManagementServiceV1Client.getPolicy(request);
}
Parameter
Name Description
request Service.GetPolicyRequest

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

Returns
Type Description

getPolicy(String name)

publicfinalResources.PolicygetPolicy(Stringname)

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:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Stringname=PolicyName.ofProjectName("[PROJECT]").toString();
Resources.Policyresponse=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

getPolicyCallable()

publicfinalUnaryCallable<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:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.GetPolicyRequestrequest=
Service.GetPolicyRequest.newBuilder()
.setName(PolicyName.ofProjectName("[PROJECT]").toString())
.build();
ApiFuture<Resources.Policy>future=
binauthzManagementServiceV1Client.getPolicyCallable().futureCall(request);
// Do something.
Resources.Policyresponse=future.get();
}
Returns
Type Description

getSettings()

publicfinalBinauthzManagementServiceV1SettingsgetSettings()
Returns
Type Description

getStub()

publicBinauthzManagementServiceV1StubgetStub()
Returns
Type Description

isShutdown()

publicbooleanisShutdown()
Returns
Type Description

isTerminated()

publicbooleanisTerminated()
Returns
Type Description

listAttestors(ProjectName parent)

publicfinalBinauthzManagementServiceV1Client.ListAttestorsPagedResponselistAttestors(ProjectNameparent)

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
ProjectNameparent=ProjectName.of("[PROJECT]");
for(Resources.Attestorelement:
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

listAttestors(Service.ListAttestorsRequest request)

publicfinalBinauthzManagementServiceV1Client.ListAttestorsPagedResponselistAttestors(Service.ListAttestorsRequestrequest)

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.ListAttestorsRequestrequest=
Service.ListAttestorsRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for(Resources.Attestorelement:
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

listAttestors(String parent)

publicfinalBinauthzManagementServiceV1Client.ListAttestorsPagedResponselistAttestors(Stringparent)

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Stringparent=ProjectName.of("[PROJECT]").toString();
for(Resources.Attestorelement:
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

listAttestorsCallable()

publicfinalUnaryCallable<Service.ListAttestorsRequest,Service.ListAttestorsResponse>listAttestorsCallable()

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.ListAttestorsRequestrequest=
Service.ListAttestorsRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while(true){
Service.ListAttestorsResponseresponse=
binauthzManagementServiceV1Client.listAttestorsCallable().call(request);
for(Resources.Attestorelement:response.getResponsesList()){
// doThingsWith(element);
}
StringnextPageToken=response.getNextPageToken();
if(!Strings.isNullOrEmpty(nextPageToken)){
request=request.toBuilder().setPageToken(nextPageToken).build();
}else{
break;
}
}
}
Returns
Type Description

listAttestorsPagedCallable()

publicfinalUnaryCallable<Service.ListAttestorsRequest,BinauthzManagementServiceV1Client.ListAttestorsPagedResponse>listAttestorsPagedCallable()

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.ListAttestorsRequestrequest=
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.Attestorelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
Returns
Type Description

shutdown()

publicvoidshutdown()

shutdownNow()

publicvoidshutdownNow()

updateAttestor(Resources.Attestor attestor)

publicfinalResources.AttestorupdateAttestor(Resources.Attestorattestor)

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Resources.Attestorattestor=Resources.Attestor.newBuilder().build();
Resources.Attestorresponse=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

updateAttestor(Service.UpdateAttestorRequest request)

publicfinalResources.AttestorupdateAttestor(Service.UpdateAttestorRequestrequest)

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.UpdateAttestorRequestrequest=
Service.UpdateAttestorRequest.newBuilder()
.setAttestor(Resources.Attestor.newBuilder().build())
.build();
Resources.Attestorresponse=binauthzManagementServiceV1Client.updateAttestor(request);
}
Parameter
Name Description
request Service.UpdateAttestorRequest

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

Returns
Type Description

updateAttestorCallable()

publicfinalUnaryCallable<Service.UpdateAttestorRequest,Resources.Attestor>updateAttestorCallable()

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

Sample code:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.UpdateAttestorRequestrequest=
Service.UpdateAttestorRequest.newBuilder()
.setAttestor(Resources.Attestor.newBuilder().build())
.build();
ApiFuture<Resources.Attestor>future=
binauthzManagementServiceV1Client.updateAttestorCallable().futureCall(request);
// Do something.
Resources.Attestorresponse=future.get();
}
Returns
Type Description

updatePolicy(Resources.Policy policy)

publicfinalResources.PolicyupdatePolicy(Resources.Policypolicy)

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:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Resources.Policypolicy=Resources.Policy.newBuilder().build();
Resources.Policyresponse=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

updatePolicy(Service.UpdatePolicyRequest request)

publicfinalResources.PolicyupdatePolicy(Service.UpdatePolicyRequestrequest)

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:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.UpdatePolicyRequestrequest=
Service.UpdatePolicyRequest.newBuilder()
.setPolicy(Resources.Policy.newBuilder().build())
.build();
Resources.Policyresponse=binauthzManagementServiceV1Client.updatePolicy(request);
}
Parameter
Name Description
request Service.UpdatePolicyRequest

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

Returns
Type Description

updatePolicyCallable()

publicfinalUnaryCallable<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:


try(BinauthzManagementServiceV1ClientbinauthzManagementServiceV1Client=
BinauthzManagementServiceV1Client.create()){
Service.UpdatePolicyRequestrequest=
Service.UpdatePolicyRequest.newBuilder()
.setPolicy(Resources.Policy.newBuilder().build())
.build();
ApiFuture<Resources.Policy>future=
binauthzManagementServiceV1Client.updatePolicyCallable().futureCall(request);
// Do something.
Resources.Policyresponse=future.get();
}
Returns
Type Description

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.