Binary Authorization v1 API - Class BinauthzManagementServiceV1ClientImpl (2.5.0) 

public sealed class BinauthzManagementServiceV1ClientImpl : BinauthzManagementServiceV1Client

Reference documentation and code samples for the Binary Authorization v1 API class BinauthzManagementServiceV1ClientImpl.

BinauthzManagementServiceV1 client wrapper implementation, for convenient use.

Inheritance

object > BinauthzManagementServiceV1Client > BinauthzManagementServiceV1ClientImpl

Namespace

Google.Cloud.BinaryAuthorization.V1

Assembly

Google.Cloud.BinaryAuthorization.V1.dll

Remarks

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

This API implements a REST model with the following objects:

  • [Policy][google.cloud.binaryauthorization.v1.Policy]
  • [Attestor][google.cloud.binaryauthorization.v1.Attestor]

Constructors

BinauthzManagementServiceV1ClientImpl(BinauthzManagementServiceV1Client, BinauthzManagementServiceV1Settings, ILogger)

public BinauthzManagementServiceV1ClientImpl(BinauthzManagementServiceV1.BinauthzManagementServiceV1Client grpcClient, BinauthzManagementServiceV1Settings settings, ILogger logger)

Constructs a client wrapper for the BinauthzManagementServiceV1 service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient BinauthzManagementServiceV1BinauthzManagementServiceV1Client

The underlying gRPC client.
settings BinauthzManagementServiceV1Settings

The base BinauthzManagementServiceV1Settings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override BinauthzManagementServiceV1.BinauthzManagementServiceV1Client GrpcClient { get; }

The underlying gRPC BinauthzManagementServiceV1 client

Property Value
Type Description
BinauthzManagementServiceV1BinauthzManagementServiceV1Client
Overrides

Methods

CreateAttestor(CreateAttestorRequest, CallSettings)

public override Attestor CreateAttestor(CreateAttestorRequest request, CallSettings callSettings = null)

Creates an [attestor][google.cloud.binaryauthorization.v1.Attestor], and returns a copy of the new [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the [attestor][google.cloud.binaryauthorization.v1.Attestor] already exists.

Parameters
Name Description
request CreateAttestorRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Attestor

The RPC response.
Overrides

CreateAttestorAsync(CreateAttestorRequest, CallSettings)

public override Task<Attestor> CreateAttestorAsync(CreateAttestorRequest request, CallSettings callSettings = null)

Creates an [attestor][google.cloud.binaryauthorization.v1.Attestor], and returns a copy of the new [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the [attestor][google.cloud.binaryauthorization.v1.Attestor] already exists.

Parameters
Name Description
request CreateAttestorRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAttestor

A Task containing the RPC response.
Overrides

DeleteAttestor(DeleteAttestorRequest, CallSettings)

public override void DeleteAttestor(DeleteAttestorRequest request, CallSettings callSettings = null)

Deletes an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.

Parameters
Name Description
request DeleteAttestorRequest

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

If not null, applies overrides to this RPC call.
Overrides

DeleteAttestorAsync(DeleteAttestorRequest, CallSettings)

public override Task DeleteAttestorAsync(DeleteAttestorRequest request, CallSettings callSettings = null)

Deletes an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.

Parameters
Name Description
request DeleteAttestorRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

GetAttestor(GetAttestorRequest, CallSettings)

public override Attestor GetAttestor(GetAttestorRequest request, CallSettings callSettings = null)

Gets an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.

Parameters
Name Description
request GetAttestorRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Attestor

The RPC response.
Overrides

GetAttestorAsync(GetAttestorRequest, CallSettings)

public override Task<Attestor> GetAttestorAsync(GetAttestorRequest request, CallSettings callSettings = null)

Gets an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.

Parameters
Name Description
request GetAttestorRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAttestor

A Task containing the RPC response.
Overrides

GetPolicy(GetPolicyRequest, CallSettings)

public override Policy GetPolicy(GetPolicyRequest request, CallSettings callSettings = null)

A [policy][google.cloud.binaryauthorization.v1.Policy] specifies the [attestors][google.cloud.binaryauthorization.v1.Attestor] 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][google.cloud.binaryauthorization.v1.Policy] for this project. Returns a default [policy][google.cloud.binaryauthorization.v1.Policy] if the project does not have one.

Parameters
Name Description
request GetPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Policy

The RPC response.
Overrides

GetPolicyAsync(GetPolicyRequest, CallSettings)

public override Task<Policy> GetPolicyAsync(GetPolicyRequest request, CallSettings callSettings = null)

A [policy][google.cloud.binaryauthorization.v1.Policy] specifies the [attestors][google.cloud.binaryauthorization.v1.Attestor] 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][google.cloud.binaryauthorization.v1.Policy] for this project. Returns a default [policy][google.cloud.binaryauthorization.v1.Policy] if the project does not have one.

Parameters
Name Description
request GetPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPolicy

A Task containing the RPC response.
Overrides

ListAttestors(ListAttestorsRequest, CallSettings)

public override PagedEnumerable<ListAttestorsResponse, Attestor> ListAttestors(ListAttestorsRequest request, CallSettings callSettings = null)

Lists [attestors][google.cloud.binaryauthorization.v1.Attestor]. Returns INVALID_ARGUMENT if the project does not exist.

Parameters
Name Description
request ListAttestorsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListAttestorsResponseAttestor

A pageable sequence of Attestor resources.
Overrides

ListAttestorsAsync(ListAttestorsRequest, CallSettings)

public override PagedAsyncEnumerable<ListAttestorsResponse, Attestor> ListAttestorsAsync(ListAttestorsRequest request, CallSettings callSettings = null)

Lists [attestors][google.cloud.binaryauthorization.v1.Attestor]. Returns INVALID_ARGUMENT if the project does not exist.

Parameters
Name Description
request ListAttestorsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListAttestorsResponseAttestor

A pageable asynchronous sequence of Attestor resources.
Overrides

UpdateAttestor(UpdateAttestorRequest, CallSettings)

public override Attestor UpdateAttestor(UpdateAttestorRequest request, CallSettings callSettings = null)

Updates an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.

Parameters
Name Description
request UpdateAttestorRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Attestor

The RPC response.
Overrides

UpdateAttestorAsync(UpdateAttestorRequest, CallSettings)

public override Task<Attestor> UpdateAttestorAsync(UpdateAttestorRequest request, CallSettings callSettings = null)

Updates an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.

Parameters
Name Description
request UpdateAttestorRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAttestor

A Task containing the RPC response.
Overrides

UpdatePolicy(UpdatePolicyRequest, CallSettings)

public override Policy UpdatePolicy(UpdatePolicyRequest request, CallSettings callSettings = null)

Creates or updates a project's [policy][google.cloud.binaryauthorization.v1.Policy], and returns a copy of the new [policy][google.cloud.binaryauthorization.v1.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.

Parameters
Name Description
request UpdatePolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Policy

The RPC response.
Overrides

UpdatePolicyAsync(UpdatePolicyRequest, CallSettings)

public override Task<Policy> UpdatePolicyAsync(UpdatePolicyRequest request, CallSettings callSettings = null)

Creates or updates a project's [policy][google.cloud.binaryauthorization.v1.Policy], and returns a copy of the new [policy][google.cloud.binaryauthorization.v1.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.

Parameters
Name Description
request UpdatePolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPolicy

A Task containing the RPC response.
Overrides