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

Class CaPool

  • All Implemented Interfaces:
    CaPoolOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class CaPool
extends com.google.protobuf.GeneratedMessageV3
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:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         Output only. 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) = OUTPUT_ONLY];
        Specified by:
        getName in interface CaPoolOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. 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) = OUTPUT_ONLY];
        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

      • 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.GeneratedMessageV3

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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​(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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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