CertificateAuthority

google.cloud.security.privateca.v1beta1. CertificateAuthority

Represents a CertificateAuthority.

Constructor

new CertificateAuthority(propertiesopt)

Constructs a new CertificateAuthority.

Parameters:
Name Type Attributes Description
properties google.cloud.security.privateca.v1beta1.ICertificateAuthority <optional>

Properties to set
Implements:
  • ICertificateAuthority

Classes

AccessUrls
CertificateAuthorityPolicy
IssuingOptions
KeyVersionSpec

Members

accessUrls

CertificateAuthority accessUrls.

caCertificateDescriptions

CertificateAuthority caCertificateDescriptions.

certificatePolicy

CertificateAuthority certificatePolicy.

config

CertificateAuthority config.

createTime

CertificateAuthority createTime.

deleteTime

CertificateAuthority deleteTime.

gcsBucket

CertificateAuthority gcsBucket.

issuingOptions

CertificateAuthority issuingOptions.

keySpec

CertificateAuthority keySpec.

labels

CertificateAuthority labels.

lifetime

CertificateAuthority lifetime.

name

CertificateAuthority name.

pemCaCertificates

CertificateAuthority pemCaCertificates.

state

CertificateAuthority state.

subordinateConfig

CertificateAuthority subordinateConfig.

tier

CertificateAuthority tier.

type

CertificateAuthority type.

updateTime

CertificateAuthority updateTime.

SignHashAlgorithm

SignHashAlgorithm enum.

Properties:
Name Type Description
SIGN_HASH_ALGORITHM_UNSPECIFIED number

SIGN_HASH_ALGORITHM_UNSPECIFIED value
RSA_PSS_2048_SHA256 number

RSA_PSS_2048_SHA256 value
RSA_PSS_3072_SHA256 number

RSA_PSS_3072_SHA256 value
RSA_PSS_4096_SHA256 number

RSA_PSS_4096_SHA256 value
RSA_PKCS1_2048_SHA256 number

RSA_PKCS1_2048_SHA256 value
RSA_PKCS1_3072_SHA256 number

RSA_PKCS1_3072_SHA256 value
RSA_PKCS1_4096_SHA256 number

RSA_PKCS1_4096_SHA256 value
EC_P256_SHA256 number

EC_P256_SHA256 value
EC_P384_SHA384 number

EC_P384_SHA384 value

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value
ENABLED number

ENABLED value
DISABLED number

DISABLED value
PENDING_ACTIVATION number

PENDING_ACTIVATION value
PENDING_DELETION number

PENDING_DELETION value

Tier

Tier enum.

Properties:
Name Type Description
TIER_UNSPECIFIED number

TIER_UNSPECIFIED value
ENTERPRISE number

ENTERPRISE value
DEVOPS number

DEVOPS value

Type

Type enum.

Properties:
Name Type Description
TYPE_UNSPECIFIED number

TYPE_UNSPECIFIED value
SELF_SIGNED number

SELF_SIGNED value
SUBORDINATE number

SUBORDINATE value

Methods

toJSON() → {Object.<string, *>}

Converts this CertificateAuthority to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.security.privateca.v1beta1.CertificateAuthority}

Creates a new CertificateAuthority instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.security.privateca.v1beta1.ICertificateAuthority <optional>

Properties to set
Returns:
Type Description
google.cloud.security.privateca.v1beta1.CertificateAuthority

CertificateAuthority instance

(static) decode(reader, lengthopt) → {google.cloud.security.privateca.v1beta1.CertificateAuthority}

Decodes a CertificateAuthority message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Returns:
Type Description
google.cloud.security.privateca.v1beta1.CertificateAuthority

CertificateAuthority
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.security.privateca.v1beta1.CertificateAuthority}

Decodes a CertificateAuthority message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Returns:
Type Description
google.cloud.security.privateca.v1beta1.CertificateAuthority

CertificateAuthority
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified CertificateAuthority message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.security.privateca.v1beta1.ICertificateAuthority

CertificateAuthority message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified CertificateAuthority message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.security.privateca.v1beta1.ICertificateAuthority

CertificateAuthority message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.security.privateca.v1beta1.CertificateAuthority}

Creates a CertificateAuthority message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
google.cloud.security.privateca.v1beta1.CertificateAuthority

CertificateAuthority

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for CertificateAuthority

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")
Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a CertificateAuthority message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.security.privateca.v1beta1.CertificateAuthority

CertificateAuthority
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a CertificateAuthority message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not