Class Resources.AdmissionRule.Builder (1.46.0)

public static final class Resources.AdmissionRule.Builder extends GeneratedMessageV3.Builder<Resources.AdmissionRule.Builder> implements Resources.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.v1.AdmissionRule

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllRequireAttestationsBy(Iterable<String> values)

public Resources.AdmissionRule.Builder addAllRequireAttestationsBy(Iterable<String> values)

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
Name Description
values Iterable<String>

The requireAttestationsBy to add.

Returns
Type Description
Resources.AdmissionRule.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Resources.AdmissionRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Resources.AdmissionRule.Builder
Overrides

addRequireAttestationsBy(String value)

public Resources.AdmissionRule.Builder addRequireAttestationsBy(String value)

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
Name Description
value String

The requireAttestationsBy to add.

Returns
Type Description
Resources.AdmissionRule.Builder

This builder for chaining.

addRequireAttestationsByBytes(ByteString value)

public Resources.AdmissionRule.Builder addRequireAttestationsByBytes(ByteString value)

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
Name Description
value ByteString

The bytes of the requireAttestationsBy to add.

Returns
Type Description
Resources.AdmissionRule.Builder

This builder for chaining.

build()

public Resources.AdmissionRule build()
Returns
Type Description
Resources.AdmissionRule

buildPartial()

public Resources.AdmissionRule buildPartial()
Returns
Type Description
Resources.AdmissionRule

clear()

public Resources.AdmissionRule.Builder clear()
Returns
Type Description
Resources.AdmissionRule.Builder
Overrides

clearEnforcementMode()

public Resources.AdmissionRule.Builder clearEnforcementMode()

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

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

Returns
Type Description
Resources.AdmissionRule.Builder

This builder for chaining.

clearEvaluationMode()

public Resources.AdmissionRule.Builder clearEvaluationMode()

Required. How this admission rule will be evaluated.

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

Returns
Type Description
Resources.AdmissionRule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Resources.AdmissionRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Resources.AdmissionRule.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Resources.AdmissionRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Resources.AdmissionRule.Builder
Overrides

clearRequireAttestationsBy()

public Resources.AdmissionRule.Builder clearRequireAttestationsBy()

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
Type Description
Resources.AdmissionRule.Builder

This builder for chaining.

clone()

public Resources.AdmissionRule.Builder clone()
Returns
Type Description
Resources.AdmissionRule.Builder
Overrides

getDefaultInstanceForType()

public Resources.AdmissionRule getDefaultInstanceForType()
Returns
Type Description
Resources.AdmissionRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnforcementMode()

public Resources.AdmissionRule.EnforcementMode getEnforcementMode()

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

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

Returns
Type Description
Resources.AdmissionRule.EnforcementMode

The enforcementMode.

getEnforcementModeValue()

public int getEnforcementModeValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for enforcementMode.

getEvaluationMode()

public Resources.AdmissionRule.EvaluationMode getEvaluationMode()

Required. How this admission rule will be evaluated.

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

Returns
Type Description
Resources.AdmissionRule.EvaluationMode

The evaluationMode.

getEvaluationModeValue()

public int getEvaluationModeValue()

Required. How this admission rule will be evaluated.

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

Returns
Type Description
int

The enum numeric value on the wire for evaluationMode.

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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

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

A list containing the requireAttestationsBy.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Resources.AdmissionRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Resources.AdmissionRule.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Resources.AdmissionRule.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Resources.AdmissionRule.Builder
Overrides

mergeFrom(Resources.AdmissionRule other)

public Resources.AdmissionRule.Builder mergeFrom(Resources.AdmissionRule other)
Parameter
Name Description
other Resources.AdmissionRule
Returns
Type Description
Resources.AdmissionRule.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Resources.AdmissionRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Resources.AdmissionRule.Builder
Overrides

setEnforcementMode(Resources.AdmissionRule.EnforcementMode value)

public Resources.AdmissionRule.Builder setEnforcementMode(Resources.AdmissionRule.EnforcementMode value)

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

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

Parameter
Name Description
value Resources.AdmissionRule.EnforcementMode

The enforcementMode to set.

Returns
Type Description
Resources.AdmissionRule.Builder

This builder for chaining.

setEnforcementModeValue(int value)

public Resources.AdmissionRule.Builder setEnforcementModeValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for enforcementMode to set.

Returns
Type Description
Resources.AdmissionRule.Builder

This builder for chaining.

setEvaluationMode(Resources.AdmissionRule.EvaluationMode value)

public Resources.AdmissionRule.Builder setEvaluationMode(Resources.AdmissionRule.EvaluationMode value)

Required. How this admission rule will be evaluated.

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

Parameter
Name Description
value Resources.AdmissionRule.EvaluationMode

The evaluationMode to set.

Returns
Type Description
Resources.AdmissionRule.Builder

This builder for chaining.

setEvaluationModeValue(int value)

public Resources.AdmissionRule.Builder setEvaluationModeValue(int value)

Required. How this admission rule will be evaluated.

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

Parameter
Name Description
value int

The enum numeric value on the wire for evaluationMode to set.

Returns
Type Description
Resources.AdmissionRule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Resources.AdmissionRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Resources.AdmissionRule.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Resources.AdmissionRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Resources.AdmissionRule.Builder
Overrides

setRequireAttestationsBy(int index, String value)

public Resources.AdmissionRule.Builder setRequireAttestationsBy(int index, String value)

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];

Parameters
Name Description
index int

The index to set the value at.

value String

The requireAttestationsBy to set.

Returns
Type Description
Resources.AdmissionRule.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Resources.AdmissionRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Resources.AdmissionRule.Builder
Overrides