Class CaPool.Builder (2.34.0)

public static final class CaPool.Builder extends GeneratedMessageV3.Builder<CaPool.Builder> implements CaPoolOrBuilder

A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor.

Protobuf type google.cloud.security.privateca.v1.CaPool

Implements

CaPoolOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CaPool.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CaPool.Builder
Overrides

build()

public CaPool build()
Returns
TypeDescription
CaPool

buildPartial()

public CaPool buildPartial()
Returns
TypeDescription
CaPool

clear()

public CaPool.Builder clear()
Returns
TypeDescription
CaPool.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public CaPool.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CaPool.Builder
Overrides

clearIssuancePolicy()

public CaPool.Builder clearIssuancePolicy()

Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.

.google.cloud.security.privateca.v1.CaPool.IssuancePolicy issuance_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CaPool.Builder

clearLabels()

public CaPool.Builder clearLabels()
Returns
TypeDescription
CaPool.Builder

clearName()

public CaPool.Builder clearName()

Output only. The resource name for this CaPool in the format projects/*/locations/*/caPools/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
CaPool.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CaPool.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CaPool.Builder
Overrides

clearPublishingOptions()

public CaPool.Builder clearPublishingOptions()

Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.

.google.cloud.security.privateca.v1.CaPool.PublishingOptions publishing_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CaPool.Builder

clearTier()

public CaPool.Builder clearTier()

Required. Immutable. The Tier of this CaPool.

.google.cloud.security.privateca.v1.CaPool.Tier tier = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
CaPool.Builder

This builder for chaining.

clone()

public CaPool.Builder clone()
Returns
TypeDescription
CaPool.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels with user-defined metadata.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public CaPool getDefaultInstanceForType()
Returns
TypeDescription
CaPool

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getIssuancePolicy()

public CaPool.IssuancePolicy getIssuancePolicy()

Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.

.google.cloud.security.privateca.v1.CaPool.IssuancePolicy issuance_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CaPool.IssuancePolicy

The issuancePolicy.

getIssuancePolicyBuilder()

public CaPool.IssuancePolicy.Builder getIssuancePolicyBuilder()

Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.

.google.cloud.security.privateca.v1.CaPool.IssuancePolicy issuance_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CaPool.IssuancePolicy.Builder

getIssuancePolicyOrBuilder()

public CaPool.IssuancePolicyOrBuilder getIssuancePolicyOrBuilder()

Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.

.google.cloud.security.privateca.v1.CaPool.IssuancePolicy issuance_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CaPool.IssuancePolicyOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels with user-defined metadata.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels with user-defined metadata.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels with user-defined metadata.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels with user-defined metadata.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

Output only. The resource name for this CaPool in the format projects/*/locations/*/caPools/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name for this CaPool in the format projects/*/locations/*/caPools/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getPublishingOptions()

public CaPool.PublishingOptions getPublishingOptions()

Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.

.google.cloud.security.privateca.v1.CaPool.PublishingOptions publishing_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CaPool.PublishingOptions

The publishingOptions.

getPublishingOptionsBuilder()

public CaPool.PublishingOptions.Builder getPublishingOptionsBuilder()

Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.

.google.cloud.security.privateca.v1.CaPool.PublishingOptions publishing_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CaPool.PublishingOptions.Builder

getPublishingOptionsOrBuilder()

public CaPool.PublishingOptionsOrBuilder getPublishingOptionsOrBuilder()

Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.

.google.cloud.security.privateca.v1.CaPool.PublishingOptions publishing_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CaPool.PublishingOptionsOrBuilder

getTier()

public CaPool.Tier getTier()

Required. Immutable. The Tier of this CaPool.

.google.cloud.security.privateca.v1.CaPool.Tier tier = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
CaPool.Tier

The tier.

getTierValue()

public int getTierValue()

Required. Immutable. The Tier of this CaPool.

.google.cloud.security.privateca.v1.CaPool.Tier tier = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
int

The enum numeric value on the wire for tier.

hasIssuancePolicy()

public boolean hasIssuancePolicy()

Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.

.google.cloud.security.privateca.v1.CaPool.IssuancePolicy issuance_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the issuancePolicy field is set.

hasPublishingOptions()

public boolean hasPublishingOptions()

Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.

.google.cloud.security.privateca.v1.CaPool.PublishingOptions publishing_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the publishingOptions field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CaPool other)

public CaPool.Builder mergeFrom(CaPool other)
Parameter
NameDescription
otherCaPool
Returns
TypeDescription
CaPool.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CaPool.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CaPool.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CaPool.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CaPool.Builder
Overrides

mergeIssuancePolicy(CaPool.IssuancePolicy value)

public CaPool.Builder mergeIssuancePolicy(CaPool.IssuancePolicy value)

Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.

.google.cloud.security.privateca.v1.CaPool.IssuancePolicy issuance_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueCaPool.IssuancePolicy
Returns
TypeDescription
CaPool.Builder

mergePublishingOptions(CaPool.PublishingOptions value)

public CaPool.Builder mergePublishingOptions(CaPool.PublishingOptions value)

Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.

.google.cloud.security.privateca.v1.CaPool.PublishingOptions publishing_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueCaPool.PublishingOptions
Returns
TypeDescription
CaPool.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CaPool.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CaPool.Builder
Overrides

putAllLabels(Map<String,String> values)

public CaPool.Builder putAllLabels(Map<String,String> values)

Optional. Labels with user-defined metadata.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
CaPool.Builder

putLabels(String key, String value)

public CaPool.Builder putLabels(String key, String value)

Optional. Labels with user-defined metadata.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
CaPool.Builder

removeLabels(String key)

public CaPool.Builder removeLabels(String key)

Optional. Labels with user-defined metadata.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
CaPool.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CaPool.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CaPool.Builder
Overrides

setIssuancePolicy(CaPool.IssuancePolicy value)

public CaPool.Builder setIssuancePolicy(CaPool.IssuancePolicy value)

Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.

.google.cloud.security.privateca.v1.CaPool.IssuancePolicy issuance_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueCaPool.IssuancePolicy
Returns
TypeDescription
CaPool.Builder

setIssuancePolicy(CaPool.IssuancePolicy.Builder builderForValue)

public CaPool.Builder setIssuancePolicy(CaPool.IssuancePolicy.Builder builderForValue)

Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.

.google.cloud.security.privateca.v1.CaPool.IssuancePolicy issuance_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValueCaPool.IssuancePolicy.Builder
Returns
TypeDescription
CaPool.Builder

setName(String value)

public CaPool.Builder setName(String value)

Output only. The resource name for this CaPool in the format projects/*/locations/*/caPools/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
CaPool.Builder

This builder for chaining.

setNameBytes(ByteString value)

public CaPool.Builder setNameBytes(ByteString value)

Output only. The resource name for this CaPool in the format projects/*/locations/*/caPools/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
CaPool.Builder

This builder for chaining.

setPublishingOptions(CaPool.PublishingOptions value)

public CaPool.Builder setPublishingOptions(CaPool.PublishingOptions value)

Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.

.google.cloud.security.privateca.v1.CaPool.PublishingOptions publishing_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueCaPool.PublishingOptions
Returns
TypeDescription
CaPool.Builder

setPublishingOptions(CaPool.PublishingOptions.Builder builderForValue)

public CaPool.Builder setPublishingOptions(CaPool.PublishingOptions.Builder builderForValue)

Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.

.google.cloud.security.privateca.v1.CaPool.PublishingOptions publishing_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValueCaPool.PublishingOptions.Builder
Returns
TypeDescription
CaPool.Builder

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

public CaPool.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CaPool.Builder
Overrides

setTier(CaPool.Tier value)

public CaPool.Builder setTier(CaPool.Tier value)

Required. Immutable. The Tier of this CaPool.

.google.cloud.security.privateca.v1.CaPool.Tier tier = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
valueCaPool.Tier

The tier to set.

Returns
TypeDescription
CaPool.Builder

This builder for chaining.

setTierValue(int value)

public CaPool.Builder setTierValue(int value)

Required. Immutable. The Tier of this CaPool.

.google.cloud.security.privateca.v1.CaPool.Tier tier = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
valueint

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

Returns
TypeDescription
CaPool.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CaPool.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CaPool.Builder
Overrides