Package com.google.cloud.security.privateca.v1

Class CaPool

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.security.privateca.v1.CaPool
All Implemented Interfaces:
CaPoolOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class CaPool extends com.google.protobuf.GeneratedMessage implements CaPoolOrBuilder
 A [CaPool][google.cloud.security.privateca.v1.CaPool] represents a group of
 [CertificateAuthorities][google.cloud.security.privateca.v1.CertificateAuthority]
 that form a trust anchor. A
 [CaPool][google.cloud.security.privateca.v1.CaPool] can be used to manage
 issuance policies for one or more
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 resources and to rotate CA certificates in and out of the trust anchor.
Protobuf type google.cloud.security.privateca.v1.CaPool
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CaPool.Builder
    A [CaPool][google.cloud.security.privateca.v1.CaPool] represents a group of [CertificateAuthorities][google.cloud.security.privateca.v1.CertificateAuthority] that form a trust anchor.
    static final class 
    CaPool.IssuancePolicy
    Defines controls over all certificate issuance within a [CaPool][google.cloud.security.privateca.v1.CaPool].
    static interface 
    CaPool.IssuancePolicyOrBuilder
     
    static final class 
    CaPool.PublishingOptions
    Options relating to the publication of each [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s CA certificate and CRLs and their inclusion as extensions in issued [Certificates][google.cloud.security.privateca.v1.Certificate].
    static interface 
    CaPool.PublishingOptionsOrBuilder
     
    static enum 
    CaPool.Tier
    The tier of a [CaPool][google.cloud.security.privateca.v1.CaPool], indicating its supported functionality and/or billing SKU.

    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
    ISSUANCE_POLICY_FIELD_NUMBER
     
    static final int
    LABELS_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    PUBLISHING_OPTIONS_FIELD_NUMBER
     
    static final int
    TIER_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
    containsLabels(String key)
    Optional.
    boolean
    equals(Object obj)
     
    static CaPool
    getDefaultInstance()
     
    CaPool
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    CaPool.IssuancePolicy
    getIssuancePolicy()
    Optional.
    CaPool.IssuancePolicyOrBuilder
    getIssuancePolicyOrBuilder()
    Optional.
    Map<String,String>
    getLabels()
    Deprecated.
    int
    getLabelsCount()
    Optional.
    Map<String,String>
    getLabelsMap()
    Optional.
    String
    getLabelsOrDefault(String key, String defaultValue)
    Optional.
    String
    getLabelsOrThrow(String key)
    Optional.
    String
    getName()
    Identifier.
    com.google.protobuf.ByteString
    getNameBytes()
    Identifier.
    com.google.protobuf.Parser<CaPool>
    getParserForType()
     
    CaPool.PublishingOptions
    getPublishingOptions()
    Optional.
    CaPool.PublishingOptionsOrBuilder
    getPublishingOptionsOrBuilder()
    Optional.
    int
    getSerializedSize()
     
    CaPool.Tier
    getTier()
    Required.
    int
    getTierValue()
    Required.
    int
    hashCode()
     
    boolean
    hasIssuancePolicy()
    Optional.
    boolean
    hasPublishingOptions()
    Optional.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static CaPool.Builder
    newBuilder()
     
    static CaPool.Builder
    newBuilder(CaPool prototype)
     
    CaPool.Builder
    newBuilderForType()
     
    protected CaPool.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static CaPool
    parseDelimitedFrom(InputStream input)
     
    static CaPool
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CaPool
    parseFrom(byte[] data)
     
    static CaPool
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CaPool
    parseFrom(com.google.protobuf.ByteString data)
     
    static CaPool
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CaPool
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CaPool
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CaPool
    parseFrom(InputStream input)
     
    static CaPool
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CaPool
    parseFrom(ByteBuffer data)
     
    static CaPool
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CaPool>
    parser()
     
    CaPool.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, 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

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • TIER_FIELD_NUMBER

      public static final int TIER_FIELD_NUMBER
      See Also:

    • ISSUANCE_POLICY_FIELD_NUMBER

      public static final int ISSUANCE_POLICY_FIELD_NUMBER
      See Also:

    • PUBLISHING_OPTIONS_FIELD_NUMBER

      public static final int PUBLISHING_OPTIONS_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       Identifier. The resource name for this
 [CaPool][google.cloud.security.privateca.v1.CaPool] in the format
 `projects/*/locations/*/caPools/*`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface CaPoolOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. The resource name for this
 [CaPool][google.cloud.security.privateca.v1.CaPool] in the format
 `projects/*/locations/*/caPools/*`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface CaPoolOrBuilder
      Returns:
      The bytes for name.

    • getTierValue

      public int getTierValue()
       Required. Immutable. The
 [Tier][google.cloud.security.privateca.v1.CaPool.Tier] of this
 [CaPool][google.cloud.security.privateca.v1.CaPool].
      .google.cloud.security.privateca.v1.CaPool.Tier tier = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getTierValue in interface CaPoolOrBuilder
      Returns:
      The enum numeric value on the wire for tier.

    • getTier

      public CaPool.Tier getTier()
       Required. Immutable. The
 [Tier][google.cloud.security.privateca.v1.CaPool.Tier] of this
 [CaPool][google.cloud.security.privateca.v1.CaPool].
      .google.cloud.security.privateca.v1.CaPool.Tier tier = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getTier in interface CaPoolOrBuilder
      Returns:
      The tier.

    • hasIssuancePolicy

      public boolean hasIssuancePolicy()
       Optional. The
 [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy]
 to control how
 [Certificates][google.cloud.security.privateca.v1.Certificate] will be
 issued from this [CaPool][google.cloud.security.privateca.v1.CaPool].
      .google.cloud.security.privateca.v1.CaPool.IssuancePolicy issuance_policy = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasIssuancePolicy in interface CaPoolOrBuilder
      Returns:
      Whether the issuancePolicy field is set.

    • getIssuancePolicy

      public CaPool.IssuancePolicy getIssuancePolicy()
       Optional. The
 [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy]
 to control how
 [Certificates][google.cloud.security.privateca.v1.Certificate] will be
 issued from this [CaPool][google.cloud.security.privateca.v1.CaPool].
      .google.cloud.security.privateca.v1.CaPool.IssuancePolicy issuance_policy = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIssuancePolicy in interface CaPoolOrBuilder
      Returns:
      The issuancePolicy.

    • getIssuancePolicyOrBuilder

      public CaPool.IssuancePolicyOrBuilder getIssuancePolicyOrBuilder()
       Optional. The
 [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy]
 to control how
 [Certificates][google.cloud.security.privateca.v1.Certificate] will be
 issued from this [CaPool][google.cloud.security.privateca.v1.CaPool].
      .google.cloud.security.privateca.v1.CaPool.IssuancePolicy issuance_policy = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIssuancePolicyOrBuilder in interface CaPoolOrBuilder

    • hasPublishingOptions

      public boolean hasPublishingOptions()
       Optional. The
 [PublishingOptions][google.cloud.security.privateca.v1.CaPool.PublishingOptions]
 to follow when issuing
 [Certificates][google.cloud.security.privateca.v1.Certificate] from any
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 in this [CaPool][google.cloud.security.privateca.v1.CaPool].
      .google.cloud.security.privateca.v1.CaPool.PublishingOptions publishing_options = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasPublishingOptions in interface CaPoolOrBuilder
      Returns:
      Whether the publishingOptions field is set.

    • getPublishingOptions

      public CaPool.PublishingOptions getPublishingOptions()
       Optional. The
 [PublishingOptions][google.cloud.security.privateca.v1.CaPool.PublishingOptions]
 to follow when issuing
 [Certificates][google.cloud.security.privateca.v1.Certificate] from any
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 in this [CaPool][google.cloud.security.privateca.v1.CaPool].
      .google.cloud.security.privateca.v1.CaPool.PublishingOptions publishing_options = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPublishingOptions in interface CaPoolOrBuilder
      Returns:
      The publishingOptions.

    • getPublishingOptionsOrBuilder

      public CaPool.PublishingOptionsOrBuilder getPublishingOptionsOrBuilder()
       Optional. The
 [PublishingOptions][google.cloud.security.privateca.v1.CaPool.PublishingOptions]
 to follow when issuing
 [Certificates][google.cloud.security.privateca.v1.Certificate] from any
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 in this [CaPool][google.cloud.security.privateca.v1.CaPool].
      .google.cloud.security.privateca.v1.CaPool.PublishingOptions publishing_options = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPublishingOptionsOrBuilder in interface CaPoolOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: CaPoolOrBuilder
       Optional. Labels with user-defined metadata.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface CaPoolOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Optional. Labels with user-defined metadata.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface CaPoolOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface CaPoolOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional. Labels with user-defined metadata.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface CaPoolOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional. Labels with user-defined metadata.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface CaPoolOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. Labels with user-defined metadata.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface CaPoolOrBuilder

    • 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 CaPool parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CaPool.Builder newBuilder()

    • newBuilder

      public static CaPool.Builder newBuilder(CaPool prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CaPool getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CaPool> 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 CaPool getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder