Class CaPool (2.29.0)

public final class CaPool extends GeneratedMessageV3 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 Fields

ISSUANCE_POLICY_FIELD_NUMBER

public static final int ISSUANCE_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PUBLISHING_OPTIONS_FIELD_NUMBER

public static final int PUBLISHING_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

TIER_FIELD_NUMBER

public static final int TIER_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CaPool getDefaultInstance()
Returns
TypeDescription
CaPool

getDescriptor()

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

newBuilder()

public static CaPool.Builder newBuilder()
Returns
TypeDescription
CaPool.Builder

newBuilder(CaPool prototype)

public static CaPool.Builder newBuilder(CaPool prototype)
Parameter
NameDescription
prototypeCaPool
Returns
TypeDescription
CaPool.Builder

parseDelimitedFrom(InputStream input)

public static CaPool parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CaPool
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CaPool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CaPool
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CaPool parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CaPool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CaPool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CaPool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CaPool parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CaPool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CaPool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CaPool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CaPool parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CaPool
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CaPool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CaPool
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CaPool parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CaPool
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CaPool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CaPool
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CaPool parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CaPool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CaPool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CaPool
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CaPool> parser()
Returns
TypeDescription
Parser<CaPool>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CaPool getDefaultInstanceForType()
Returns
TypeDescription
CaPool

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.

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()

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

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.

getParserForType()

public Parser<CaPool> getParserForType()
Returns
TypeDescription
Parser<CaPool>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CaPool.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CaPool.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException