Package com.google.cloud.binaryauthorization.v1beta1

Class AdmissionRule

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.binaryauthorization.v1beta1.AdmissionRule
All Implemented Interfaces:
AdmissionRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AdmissionRule extends com.google.protobuf.GeneratedMessage implements AdmissionRuleOrBuilder
 An [admission rule][google.cloud.binaryauthorization.v1beta1.AdmissionRule] specifies either that all container images
 used in a pod creation request must be attested to by one or more
 [attestors][google.cloud.binaryauthorization.v1beta1.Attestor], that all pod creations will be allowed, or that all
 pod creations will be denied.

 Images matching an [admission allowlist pattern][google.cloud.binaryauthorization.v1beta1.AdmissionWhitelistPattern]
 are exempted from admission rules and will never block a pod creation.
Protobuf type google.cloud.binaryauthorization.v1beta1.AdmissionRule
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AdmissionRule.Builder
    An [admission rule][google.cloud.binaryauthorization.v1beta1.AdmissionRule] specifies either that all container images used in a pod creation request must be attested to by one or more [attestors][google.cloud.binaryauthorization.v1beta1.Attestor], that all pod creations will be allowed, or that all pod creations will be denied.
    static enum 
    AdmissionRule.EnforcementMode
    Defines the possible actions when a pod creation is denied by an admission rule.
    static enum 
    AdmissionRule.EvaluationMode
    Protobuf enum google.cloud.binaryauthorization.v1beta1.AdmissionRule.EvaluationMode

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ENFORCEMENT_MODE_FIELD_NUMBER
     
    static final int
    EVALUATION_MODE_FIELD_NUMBER
     
    static final int
    REQUIRE_ATTESTATIONS_BY_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static AdmissionRule
    getDefaultInstance()
     
    AdmissionRule
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    AdmissionRule.EnforcementMode
    getEnforcementMode()
    Required.
    int
    getEnforcementModeValue()
    Required.
    AdmissionRule.EvaluationMode
    getEvaluationMode()
    Required.
    int
    getEvaluationModeValue()
    Required.
    com.google.protobuf.Parser<AdmissionRule>
    getParserForType()
     
    String
    getRequireAttestationsBy(int index)
    Optional.
    com.google.protobuf.ByteString
    getRequireAttestationsByBytes(int index)
    Optional.
    int
    getRequireAttestationsByCount()
    Optional.
    com.google.protobuf.ProtocolStringList
    getRequireAttestationsByList()
    Optional.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static AdmissionRule.Builder
    newBuilder()
     
    static AdmissionRule.Builder
    newBuilder(AdmissionRule prototype)
     
    AdmissionRule.Builder
    newBuilderForType()
     
    protected AdmissionRule.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static AdmissionRule
    parseDelimitedFrom(InputStream input)
     
    static AdmissionRule
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AdmissionRule
    parseFrom(byte[] data)
     
    static AdmissionRule
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AdmissionRule
    parseFrom(com.google.protobuf.ByteString data)
     
    static AdmissionRule
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AdmissionRule
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static AdmissionRule
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AdmissionRule
    parseFrom(InputStream input)
     
    static AdmissionRule
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AdmissionRule
    parseFrom(ByteBuffer data)
     
    static AdmissionRule
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<AdmissionRule>
    parser()
     
    AdmissionRule.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • EVALUATION_MODE_FIELD_NUMBER

      public static final int EVALUATION_MODE_FIELD_NUMBER
      See Also:

    • REQUIRE_ATTESTATIONS_BY_FIELD_NUMBER

      public static final int REQUIRE_ATTESTATIONS_BY_FIELD_NUMBER
      See Also:

    • ENFORCEMENT_MODE_FIELD_NUMBER

      public static final int ENFORCEMENT_MODE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      getEvaluationModeValue in interface AdmissionRuleOrBuilder
      Returns:
      The enum numeric value on the wire for evaluationMode.

    • 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];
      Specified by:
      getEvaluationMode in interface AdmissionRuleOrBuilder
      Returns:
      The evaluationMode.

    • getRequireAttestationsByList

      public com.google.protobuf.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];
      Specified by:
      getRequireAttestationsByList in interface AdmissionRuleOrBuilder
      Returns:
      A list containing the requireAttestationsBy.

    • 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];
      Specified by:
      getRequireAttestationsByCount in interface AdmissionRuleOrBuilder
      Returns:
      The count of requireAttestationsBy.

    • getRequireAttestationsBy

      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];
      Specified by:
      getRequireAttestationsBy in interface AdmissionRuleOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The requireAttestationsBy at the given index.

    • getRequireAttestationsByBytes

      public com.google.protobuf.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];
      Specified by:
      getRequireAttestationsByBytes in interface AdmissionRuleOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the requireAttestationsBy at the given index.

    • 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];
      Specified by:
      getEnforcementModeValue in interface AdmissionRuleOrBuilder
      Returns:
      The enum numeric value on the wire for enforcementMode.

    • 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];
      Specified by:
      getEnforcementMode in interface AdmissionRuleOrBuilder
      Returns:
      The enforcementMode.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static AdmissionRule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AdmissionRule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AdmissionRule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AdmissionRule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AdmissionRule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AdmissionRule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AdmissionRule parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AdmissionRule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AdmissionRule parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AdmissionRule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AdmissionRule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AdmissionRule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public AdmissionRule.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static AdmissionRule.Builder newBuilder()

    • newBuilder

      public static AdmissionRule.Builder newBuilder(AdmissionRule prototype)

    • toBuilder

      public AdmissionRule.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected AdmissionRule.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static AdmissionRule getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AdmissionRule> parser()

    • getParserForType

      public com.google.protobuf.Parser<AdmissionRule> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public AdmissionRule getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder