Class CaPool.Builder (2.5.0)

Version 2.5.0

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.4
• 2.4.0
• 2.3.0
• 2.2.5

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CaPool.Builder

Implements

CaPoolOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CaPool.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
CaPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public CaPool build()

Returns

Type	Description
CaPool

buildPartial()

public CaPool buildPartial()

Returns

Type	Description
CaPool

clear()

public CaPool.Builder clear()

Returns

Type	Description
CaPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public CaPool.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
CaPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

Type	Description
CaPool.Builder

clearLabels()

public CaPool.Builder clearLabels()

Returns

Type	Description
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

Type	Description
CaPool.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CaPool.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
CaPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Type	Description
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

Type	Description
CaPool.Builder	This builder for chaining.

clone()

public CaPool.Builder clone()

Returns

Type	Description
CaPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

Name	Description
key	String

Returns

Type	Description
boolean

getDefaultInstanceForType()

public CaPool getDefaultInstanceForType()

Returns

Type	Description
CaPool

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

Type	Description
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

Type	Description
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

Type	Description
CaPool.IssuancePolicyOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels with user-defined metadata.

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

Returns

Type	Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels with user-defined metadata.

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

Returns

Type	Description
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

Name	Description
key	String
defaultValue	String

Returns

Type	Description
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

Name	Description
key	String

Returns

Type	Description
String

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
boolean	Whether the publishingOptions field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CaPool other)

public CaPool.Builder mergeFrom(CaPool other)

Parameter

Name	Description
other	CaPool

Returns

Type	Description
CaPool.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CaPool.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
CaPool.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public CaPool.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
CaPool.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

Name	Description
value	CaPool.IssuancePolicy

Returns

Type	Description
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

Name	Description
value	CaPool.PublishingOptions

Returns

Type	Description
CaPool.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CaPool.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
CaPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

Name	Description
values	Map<String,String>

Returns

Type	Description
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

Name	Description
key	String
value	String

Returns

Type	Description
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

Name	Description
key	String

Returns

Type	Description
CaPool.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CaPool.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
CaPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

Name	Description
value	CaPool.IssuancePolicy

Returns

Type	Description
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

Name	Description
builderForValue	CaPool.IssuancePolicy.Builder

Returns

Type	Description
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

Name	Description
value	String The name to set.

Returns

Type	Description
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

Name	Description
value	ByteString The bytes for name to set.

Returns

Type	Description
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

Name	Description
value	CaPool.PublishingOptions

Returns

Type	Description
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

Name	Description
builderForValue	CaPool.PublishingOptions.Builder

Returns

Type	Description
CaPool.Builder

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
CaPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

Name	Description
value	CaPool.Tier The tier to set.

Returns

Type	Description
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

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

Returns

Type	Description
CaPool.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CaPool.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
CaPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)