Class X509Parameters (2.55.0)

public final class X509Parameters extends GeneratedMessageV3 implements X509ParametersOrBuilder

An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.

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

Static Fields

ADDITIONAL_EXTENSIONS_FIELD_NUMBER

public static final int ADDITIONAL_EXTENSIONS_FIELD_NUMBER
Field Value
Type Description
int

AIA_OCSP_SERVERS_FIELD_NUMBER

public static final int AIA_OCSP_SERVERS_FIELD_NUMBER
Field Value
Type Description
int

CA_OPTIONS_FIELD_NUMBER

public static final int CA_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

KEY_USAGE_FIELD_NUMBER

public static final int KEY_USAGE_FIELD_NUMBER
Field Value
Type Description
int

NAME_CONSTRAINTS_FIELD_NUMBER

public static final int NAME_CONSTRAINTS_FIELD_NUMBER
Field Value
Type Description
int

POLICY_IDS_FIELD_NUMBER

public static final int POLICY_IDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static X509Parameters getDefaultInstance()
Returns
Type Description
X509Parameters

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static X509Parameters.Builder newBuilder()
Returns
Type Description
X509Parameters.Builder

newBuilder(X509Parameters prototype)

public static X509Parameters.Builder newBuilder(X509Parameters prototype)
Parameter
Name Description
prototype X509Parameters
Returns
Type Description
X509Parameters.Builder

parseDelimitedFrom(InputStream input)

public static X509Parameters parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
X509Parameters
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static X509Parameters parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
X509Parameters
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static X509Parameters parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
X509Parameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static X509Parameters parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
X509Parameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static X509Parameters parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
X509Parameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static X509Parameters parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
X509Parameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static X509Parameters parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
X509Parameters
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static X509Parameters parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
X509Parameters
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static X509Parameters parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
X509Parameters
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static X509Parameters parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
X509Parameters
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static X509Parameters parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
X509Parameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static X509Parameters parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
X509Parameters
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<X509Parameters> parser()
Returns
Type Description
Parser<X509Parameters>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdditionalExtensions(int index)

public X509Extension getAdditionalExtensions(int index)

Optional. Describes custom X.509 extensions.

repeated .google.cloud.security.privateca.v1.X509Extension additional_extensions = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
X509Extension

getAdditionalExtensionsCount()

public int getAdditionalExtensionsCount()

Optional. Describes custom X.509 extensions.

repeated .google.cloud.security.privateca.v1.X509Extension additional_extensions = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAdditionalExtensionsList()

public List<X509Extension> getAdditionalExtensionsList()

Optional. Describes custom X.509 extensions.

repeated .google.cloud.security.privateca.v1.X509Extension additional_extensions = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<X509Extension>

getAdditionalExtensionsOrBuilder(int index)

public X509ExtensionOrBuilder getAdditionalExtensionsOrBuilder(int index)

Optional. Describes custom X.509 extensions.

repeated .google.cloud.security.privateca.v1.X509Extension additional_extensions = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
X509ExtensionOrBuilder

getAdditionalExtensionsOrBuilderList()

public List<? extends X509ExtensionOrBuilder> getAdditionalExtensionsOrBuilderList()

Optional. Describes custom X.509 extensions.

repeated .google.cloud.security.privateca.v1.X509Extension additional_extensions = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.security.privateca.v1.X509ExtensionOrBuilder>

getAiaOcspServers(int index)

public String getAiaOcspServers(int index)

Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

repeated string aia_ocsp_servers = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The aiaOcspServers at the given index.

getAiaOcspServersBytes(int index)

public ByteString getAiaOcspServersBytes(int index)

Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

repeated string aia_ocsp_servers = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the aiaOcspServers at the given index.

getAiaOcspServersCount()

public int getAiaOcspServersCount()

Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

repeated string aia_ocsp_servers = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of aiaOcspServers.

getAiaOcspServersList()

public ProtocolStringList getAiaOcspServersList()

Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

repeated string aia_ocsp_servers = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the aiaOcspServers.

getCaOptions()

public X509Parameters.CaOptions getCaOptions()

Optional. Describes options in this X509Parameters that are relevant in a CA certificate.

.google.cloud.security.privateca.v1.X509Parameters.CaOptions ca_options = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
X509Parameters.CaOptions

The caOptions.

getCaOptionsOrBuilder()

public X509Parameters.CaOptionsOrBuilder getCaOptionsOrBuilder()

Optional. Describes options in this X509Parameters that are relevant in a CA certificate.

.google.cloud.security.privateca.v1.X509Parameters.CaOptions ca_options = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
X509Parameters.CaOptionsOrBuilder

getDefaultInstanceForType()

public X509Parameters getDefaultInstanceForType()
Returns
Type Description
X509Parameters

getKeyUsage()

public KeyUsage getKeyUsage()

Optional. Indicates the intended use for keys that correspond to a certificate.

.google.cloud.security.privateca.v1.KeyUsage key_usage = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
KeyUsage

The keyUsage.

getKeyUsageOrBuilder()

public KeyUsageOrBuilder getKeyUsageOrBuilder()

Optional. Indicates the intended use for keys that correspond to a certificate.

.google.cloud.security.privateca.v1.KeyUsage key_usage = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
KeyUsageOrBuilder

getNameConstraints()

public X509Parameters.NameConstraints getNameConstraints()

Optional. Describes the X.509 name constraints extension.

.google.cloud.security.privateca.v1.X509Parameters.NameConstraints name_constraints = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
X509Parameters.NameConstraints

The nameConstraints.

getNameConstraintsOrBuilder()

public X509Parameters.NameConstraintsOrBuilder getNameConstraintsOrBuilder()

Optional. Describes the X.509 name constraints extension.

.google.cloud.security.privateca.v1.X509Parameters.NameConstraints name_constraints = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
X509Parameters.NameConstraintsOrBuilder

getParserForType()

public Parser<X509Parameters> getParserForType()
Returns
Type Description
Parser<X509Parameters>
Overrides

getPolicyIds(int index)

public ObjectId getPolicyIds(int index)

Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.

repeated .google.cloud.security.privateca.v1.ObjectId policy_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ObjectId

getPolicyIdsCount()

public int getPolicyIdsCount()

Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.

repeated .google.cloud.security.privateca.v1.ObjectId policy_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getPolicyIdsList()

public List<ObjectId> getPolicyIdsList()

Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.

repeated .google.cloud.security.privateca.v1.ObjectId policy_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ObjectId>

getPolicyIdsOrBuilder(int index)

public ObjectIdOrBuilder getPolicyIdsOrBuilder(int index)

Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.

repeated .google.cloud.security.privateca.v1.ObjectId policy_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ObjectIdOrBuilder

getPolicyIdsOrBuilderList()

public List<? extends ObjectIdOrBuilder> getPolicyIdsOrBuilderList()

Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.

repeated .google.cloud.security.privateca.v1.ObjectId policy_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.security.privateca.v1.ObjectIdOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCaOptions()

public boolean hasCaOptions()

Optional. Describes options in this X509Parameters that are relevant in a CA certificate.

.google.cloud.security.privateca.v1.X509Parameters.CaOptions ca_options = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the caOptions field is set.

hasKeyUsage()

public boolean hasKeyUsage()

Optional. Indicates the intended use for keys that correspond to a certificate.

.google.cloud.security.privateca.v1.KeyUsage key_usage = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the keyUsage field is set.

hasNameConstraints()

public boolean hasNameConstraints()

Optional. Describes the X.509 name constraints extension.

.google.cloud.security.privateca.v1.X509Parameters.NameConstraints name_constraints = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the nameConstraints field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public X509Parameters.Builder newBuilderForType()
Returns
Type Description
X509Parameters.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected X509Parameters.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
X509Parameters.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public X509Parameters.Builder toBuilder()
Returns
Type Description
X509Parameters.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException