Class AdmissionRule

public final class AdmissionRule extends GeneratedMessageV3 implements AdmissionRuleOrBuilder

An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation.

Protobuf type google.cloud.binaryauthorization.v1beta1.AdmissionRule

Static Fields

ENFORCEMENT_MODE_FIELD_NUMBER

public static final int ENFORCEMENT_MODE_FIELD_NUMBER
Field Value
TypeDescription
int

EVALUATION_MODE_FIELD_NUMBER

public static final int EVALUATION_MODE_FIELD_NUMBER
Field Value
TypeDescription
int

REQUIRE_ATTESTATIONS_BY_FIELD_NUMBER

public static final int REQUIRE_ATTESTATIONS_BY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AdmissionRule getDefaultInstance()
Returns
TypeDescription
AdmissionRule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AdmissionRule.Builder newBuilder()
Returns
TypeDescription
AdmissionRule.Builder

newBuilder(AdmissionRule prototype)

public static AdmissionRule.Builder newBuilder(AdmissionRule prototype)
Parameter
NameDescription
prototypeAdmissionRule
Returns
TypeDescription
AdmissionRule.Builder

parseDelimitedFrom(InputStream input)

public static AdmissionRule parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AdmissionRule
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AdmissionRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AdmissionRule
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AdmissionRule parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AdmissionRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AdmissionRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AdmissionRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AdmissionRule parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AdmissionRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AdmissionRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AdmissionRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AdmissionRule parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AdmissionRule
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AdmissionRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AdmissionRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AdmissionRule parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AdmissionRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AdmissionRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AdmissionRule
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AdmissionRule parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AdmissionRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AdmissionRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AdmissionRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AdmissionRule> parser()
Returns
TypeDescription
Parser<AdmissionRule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public AdmissionRule getDefaultInstanceForType()
Returns
TypeDescription
AdmissionRule

getEnforcementMode()

public AdmissionRule.EnforcementMode getEnforcementMode()

Required. The action when a pod creation is denied by the admission rule.

.google.cloud.binaryauthorization.v1beta1.AdmissionRule.EnforcementMode enforcement_mode = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AdmissionRule.EnforcementMode

The enforcementMode.

getEnforcementModeValue()

public int getEnforcementModeValue()

Required. The action when a pod creation is denied by the admission rule.

.google.cloud.binaryauthorization.v1beta1.AdmissionRule.EnforcementMode enforcement_mode = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for enforcementMode.

getEvaluationMode()

public AdmissionRule.EvaluationMode getEvaluationMode()

Required. How this admission rule will be evaluated.

.google.cloud.binaryauthorization.v1beta1.AdmissionRule.EvaluationMode evaluation_mode = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AdmissionRule.EvaluationMode

The evaluationMode.

getEvaluationModeValue()

public int getEvaluationModeValue()

Required. How this admission rule will be evaluated.

.google.cloud.binaryauthorization.v1beta1.AdmissionRule.EvaluationMode evaluation_mode = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for evaluationMode.

getParserForType()

public Parser<AdmissionRule> getParserForType()
Returns
TypeDescription
Parser<AdmissionRule>
Overrides

getRequireAttestationsBy(int index)

public String getRequireAttestationsBy(int index)

Optional. The resource names of the attestors that must attest to a container image, in the format projects/*/attestors/*. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty.

repeated string require_attestations_by = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The requireAttestationsBy at the given index.

getRequireAttestationsByBytes(int index)

public ByteString getRequireAttestationsByBytes(int index)

Optional. The resource names of the attestors that must attest to a container image, in the format projects/*/attestors/*. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty.

repeated string require_attestations_by = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the requireAttestationsBy at the given index.

getRequireAttestationsByCount()

public int getRequireAttestationsByCount()

Optional. The resource names of the attestors that must attest to a container image, in the format projects/*/attestors/*. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty.

repeated string require_attestations_by = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The count of requireAttestationsBy.

getRequireAttestationsByList()

public ProtocolStringList getRequireAttestationsByList()

Optional. The resource names of the attestors that must attest to a container image, in the format projects/*/attestors/*. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be empty.

repeated string require_attestations_by = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ProtocolStringList

A list containing the requireAttestationsBy.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AdmissionRule.Builder newBuilderForType()
Returns
TypeDescription
AdmissionRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AdmissionRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AdmissionRule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AdmissionRule.Builder toBuilder()
Returns
TypeDescription
AdmissionRule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException