Package Classes (1.15.0)

Summary of entries of Classes for binaryauthorization.

Classes

BinauthzManagementServiceV1AsyncClient

Google Cloud Management Service for Binary Authorization admissionpolicies and attestation authorities.

This API implements a REST model with the following objects:

  • Policy
  • Attestor

BinauthzManagementServiceV1Client

Google Cloud Management Service for Binary Authorization admissionpolicies and attestation authorities.

This API implements a REST model with the following objects:

  • Policy
  • Attestor

ListAttestorsAsyncPager

A pager for iterating throughlist_attestors requests.

This class thinly wraps an initialListAttestorsResponse object, andprovides an__aiter__ method to iterate through itsattestors field.

If there are more pages, the__aiter__ method will make additionalListAttestors requests and continue to iteratethrough theattestors field on thecorresponding responses.

All the usualListAttestorsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListAttestorsPager

A pager for iterating throughlist_attestors requests.

This class thinly wraps an initialListAttestorsResponse object, andprovides an__iter__ method to iterate through itsattestors field.

If there are more pages, the__iter__ method will make additionalListAttestors requests and continue to iteratethrough theattestors field on thecorresponding responses.

All the usualListAttestorsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

SystemPolicyV1AsyncClient

API for working with the system policy.

SystemPolicyV1Client

API for working with the system policy.

ValidationHelperV1AsyncClient

BinAuthz Attestor verification

ValidationHelperV1Client

BinAuthz Attestor verification

AdmissionRule

An [admissionrule][google.cloud.binaryauthorization.v1.AdmissionRule] specifieseither that all container images used in a pod creation request mustbe attested to by one or moreattestors, that allpod creations will be allowed, or that all pod creations will bedenied.

Images matching an [admission allowlistpattern][google.cloud.binaryauthorization.v1.AdmissionWhitelistPattern]are exempted from admission rules and will never block a podcreation.

EnforcementMode

Defines the possible actions when a pod creation is denied byan admission rule.

EvaluationMode

AdmissionWhitelistPattern

An [admission allowlistpattern][google.cloud.binaryauthorization.v1.AdmissionWhitelistPattern]exempts images from checks by [admissionrules][google.cloud.binaryauthorization.v1.AdmissionRule].

Attestor

Anattestor thatattests to container image artifacts. An existing attestor cannot bemodified except where indicated.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AttestorPublicKey

An [attestor publickey][google.cloud.binaryauthorization.v1.AttestorPublicKey] thatwill be used to verify attestations signed by this attestor.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CreateAttestorRequest

Request message for [BinauthzManagementService.CreateAttestor][].

DeleteAttestorRequest

Request message for [BinauthzManagementService.DeleteAttestor][].

GetAttestorRequest

Request message for [BinauthzManagementService.GetAttestor][].

GetPolicyRequest

Request message for [BinauthzManagementService.GetPolicy][].

GetSystemPolicyRequest

Request to read the current system policy.

ListAttestorsRequest

Request message for [BinauthzManagementService.ListAttestors][].

ListAttestorsResponse

Response message for [BinauthzManagementService.ListAttestors][].

PkixPublicKey

A public key in the PkixPublicKey format (seehttps://tools.ietf.org/html/rfc5280#section-4.1.2.7 fordetails). Public keys of this type are typically textuallyencoded using the PEM format.

SignatureAlgorithm

Represents a signature algorithm and other informationnecessary to verify signatures with a given public key. This isbased primarily on the public key types supported by Tink'sPemKeyType, which is in turn based on KMS's supported signingalgorithms. Seehttps://cloud.google.com/kms/docs/algorithms. Inthe future, BinAuthz might support additional public key typesindependently of Tink and/or KMS.

Policy

Apolicy for containerimage binary authorization.

ClusterAdmissionRulesEntry

The abstract base class for a message.

GlobalPolicyEvaluationMode

IstioServiceIdentityAdmissionRulesEntry

The abstract base class for a message.

KubernetesNamespaceAdmissionRulesEntry

The abstract base class for a message.

KubernetesServiceAccountAdmissionRulesEntry

The abstract base class for a message.

UpdateAttestorRequest

Request message for [BinauthzManagementService.UpdateAttestor][].

UpdatePolicyRequest

Request message for [BinauthzManagementService.UpdatePolicy][].

UserOwnedGrafeasNote

An [user owned Grafeasnote][google.cloud.binaryauthorization.v1.UserOwnedGrafeasNote]references a Grafeas Attestation.Authority Note created by the user.

ValidateAttestationOccurrenceRequest

Request message forValidationHelperV1.ValidateAttestationOccurrence.

ValidateAttestationOccurrenceResponse

Response message forValidationHelperV1.ValidateAttestationOccurrence.

Result

The enum returned in the "result" field.

BinauthzManagementServiceV1Beta1AsyncClient

Google Cloud Management Service for Binary Authorization admissionpolicies and attestation authorities.

This API implements a REST model with the following objects:

  • Policy
  • Attestor

BinauthzManagementServiceV1Beta1Client

Google Cloud Management Service for Binary Authorization admissionpolicies and attestation authorities.

This API implements a REST model with the following objects:

  • Policy
  • Attestor

ListAttestorsAsyncPager

A pager for iterating throughlist_attestors requests.

This class thinly wraps an initialListAttestorsResponse object, andprovides an__aiter__ method to iterate through itsattestors field.

If there are more pages, the__aiter__ method will make additionalListAttestors requests and continue to iteratethrough theattestors field on thecorresponding responses.

All the usualListAttestorsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListAttestorsPager

A pager for iterating throughlist_attestors requests.

This class thinly wraps an initialListAttestorsResponse object, andprovides an__iter__ method to iterate through itsattestors field.

If there are more pages, the__iter__ method will make additionalListAttestors requests and continue to iteratethrough theattestors field on thecorresponding responses.

All the usualListAttestorsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

SystemPolicyV1Beta1AsyncClient

API for working with the system policy.

SystemPolicyV1Beta1Client

API for working with the system policy.

AdmissionRule

An [admissionrule][google.cloud.binaryauthorization.v1beta1.AdmissionRule]specifies either that all container images used in a pod creationrequest must be attested to by one or moreattestors, thatall pod creations will be allowed, or that all pod creations will bedenied.

Images matching an [admission allowlistpattern][google.cloud.binaryauthorization.v1beta1.AdmissionWhitelistPattern]are exempted from admission rules and will never block a podcreation.

EnforcementMode

Defines the possible actions when a pod creation is denied byan admission rule.

EvaluationMode

AdmissionWhitelistPattern

An [admission allowlistpattern][google.cloud.binaryauthorization.v1beta1.AdmissionWhitelistPattern]exempts images from checks by [admissionrules][google.cloud.binaryauthorization.v1beta1.AdmissionRule].

Attestor

Anattestorthat attests to container image artifacts. An existing attestorcannot be modified except where indicated.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AttestorPublicKey

An [attestor publickey][google.cloud.binaryauthorization.v1beta1.AttestorPublicKey]that will be used to verify attestations signed by this attestor.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ContinuousValidationEvent

Represents an auditing event from Continuous Validation.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ConfigErrorEvent

An event describing a user-actionable configuration issuethat prevents CV from auditing.

ContinuousValidationPodEvent

An auditing event for one Pod.

ImageDetails

Container image with auditing details.

AuditResult

Result of the audit.

CheckResult

CheckSetScope

A scope specifier for check sets.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CheckVerdict

Result of evaluating one check.

ContainerType

The container type.

PolicyConformanceVerdict

Audit time policy conformance verdict.

CreateAttestorRequest

Request message for [BinauthzManagementService.CreateAttestor][].

DeleteAttestorRequest

Request message for [BinauthzManagementService.DeleteAttestor][].

GetAttestorRequest

Request message for [BinauthzManagementService.GetAttestor][].

GetPolicyRequest

Request message for [BinauthzManagementService.GetPolicy][].

GetSystemPolicyRequest

Request to read the current system policy.

ListAttestorsRequest

Request message for [BinauthzManagementService.ListAttestors][].

ListAttestorsResponse

Response message for [BinauthzManagementService.ListAttestors][].

PkixPublicKey

A public key in the PkixPublicKey format (seehttps://tools.ietf.org/html/rfc5280#section-4.1.2.7 fordetails). Public keys of this type are typically textuallyencoded using the PEM format.

SignatureAlgorithm

Represents a signature algorithm and other informationnecessary to verify signatures with a given public key. This isbased primarily on the public key types supported by Tink'sPemKeyType, which is in turn based on KMS's supported signingalgorithms. Seehttps://cloud.google.com/kms/docs/algorithms. Inthe future, BinAuthz might support additional public key typesindependently of Tink and/or KMS.

Policy

Apolicy forBinary Authorization.

ClusterAdmissionRulesEntry

The abstract base class for a message.

GlobalPolicyEvaluationMode

IstioServiceIdentityAdmissionRulesEntry

The abstract base class for a message.

KubernetesNamespaceAdmissionRulesEntry

The abstract base class for a message.

KubernetesServiceAccountAdmissionRulesEntry

The abstract base class for a message.

UpdateAttestorRequest

Request message for [BinauthzManagementService.UpdateAttestor][].

UpdatePolicyRequest

Request message for [BinauthzManagementService.UpdatePolicy][].

UserOwnedDrydockNote

An [user owned drydocknote][google.cloud.binaryauthorization.v1beta1.UserOwnedDrydockNote]references a Drydock ATTESTATION_AUTHORITY Note created by the user.

Modules

pagers

API documentation forbinaryauthorization_v1.services.binauthz_management_service_v1.pagers module.

pagers

API documentation forbinaryauthorization_v1beta1.services.binauthz_management_service_v1_beta1.pagers module.

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

Last updated 2026-01-10 UTC.