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

Class CaPool.Builder

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

    • Method Detail

      • 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.Builder<CaPool.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<CaPool.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<CaPool.Builder>

      • clear

        public CaPool.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<CaPool.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CaPool.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public CaPool.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<CaPool.Builder>

      • setField

        public CaPool.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                               Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<CaPool.Builder>

      • clearField

        public CaPool.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<CaPool.Builder>

      • clearOneof

        public CaPool.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CaPool.Builder>

      • setRepeatedField

        public CaPool.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       int index,
                                       Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CaPool.Builder>

      • addRepeatedField

        public CaPool.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CaPool.Builder>

      • mergeFrom

        public CaPool.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CaPool.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CaPool.Builder>

      • mergeFrom

        public CaPool.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CaPool.Builder>
        Throws:
        IOException

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

      • setName

        public CaPool.Builder setName​(String value)
         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];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public CaPool.Builder clearName()
         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];
        Returns:
        This builder for chaining.

      • setNameBytes

        public CaPool.Builder setNameBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

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

      • setTierValue

        public CaPool.Builder setTierValue​(int value)
         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];
        Parameters:
        value - The enum numeric value on the wire for tier to set.
        Returns:
        This builder for chaining.

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

      • setTier

        public CaPool.Builder setTier​(CaPool.Tier value)
         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];
        Parameters:
        value - The tier to set.
        Returns:
        This builder for chaining.

      • clearTier

        public CaPool.Builder clearTier()
         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];
        Returns:
        This builder for chaining.

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

      • setIssuancePolicy

        public CaPool.Builder setIssuancePolicy​(CaPool.IssuancePolicy value)
         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];

      • setIssuancePolicy

        public CaPool.Builder setIssuancePolicy​(CaPool.IssuancePolicy.Builder builderForValue)
         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];

      • mergeIssuancePolicy

        public CaPool.Builder mergeIssuancePolicy​(CaPool.IssuancePolicy value)
         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];

      • clearIssuancePolicy

        public CaPool.Builder clearIssuancePolicy()
         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];

      • getIssuancePolicyBuilder

        public CaPool.IssuancePolicy.Builder getIssuancePolicyBuilder()
         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];

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

      • setPublishingOptions

        public CaPool.Builder setPublishingOptions​(CaPool.PublishingOptions value)
         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];

      • setPublishingOptions

        public CaPool.Builder setPublishingOptions​(CaPool.PublishingOptions.Builder builderForValue)
         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];

      • mergePublishingOptions

        public CaPool.Builder mergePublishingOptions​(CaPool.PublishingOptions value)
         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];

      • clearPublishingOptions

        public CaPool.Builder clearPublishingOptions()
         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];

      • getPublishingOptionsBuilder

        public CaPool.PublishingOptions.Builder getPublishingOptionsBuilder()
         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];

      • 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

      • removeLabels

        public CaPool.Builder removeLabels​(String key)
         Optional. Labels with user-defined metadata.
        map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getMutableLabels

        @Deprecated
public Map<String,​String> getMutableLabels()
        Deprecated.
        Use alternate mutation accessors instead.

      • putLabels

        public CaPool.Builder putLabels​(String key,
                                String value)
         Optional. Labels with user-defined metadata.
        map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

      • putAllLabels

        public CaPool.Builder putAllLabels​(Map<String,​String> values)
         Optional. Labels with user-defined metadata.
        map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

      • setUnknownFields

        public final CaPool.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CaPool.Builder>

      • mergeUnknownFields

        public final CaPool.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CaPool.Builder>