KeyUsageOptions

google.cloud.security.privateca.v1beta1.KeyUsage. KeyUsageOptions

Represents a KeyUsageOptions.

Constructor

new KeyUsageOptions(propertiesopt)

Constructs a new KeyUsageOptions.

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

Properties to set

Implements:
  • IKeyUsageOptions

Members

certSign

KeyUsageOptions certSign.

contentCommitment

KeyUsageOptions contentCommitment.

crlSign

KeyUsageOptions crlSign.

dataEncipherment

KeyUsageOptions dataEncipherment.

decipherOnly

KeyUsageOptions decipherOnly.

digitalSignature

KeyUsageOptions digitalSignature.

encipherOnly

KeyUsageOptions encipherOnly.

keyAgreement

KeyUsageOptions keyAgreement.

keyEncipherment

KeyUsageOptions keyEncipherment.

Methods

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

Converts this KeyUsageOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new KeyUsageOptions instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.cloud.security.privateca.v1beta1.KeyUsage.KeyUsageOptions

KeyUsageOptions instance

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

Decodes a KeyUsageOptions 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.KeyUsage.KeyUsageOptions

KeyUsageOptions

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.KeyUsage.KeyUsageOptions}

Decodes a KeyUsageOptions 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.KeyUsage.KeyUsageOptions

KeyUsageOptions

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 KeyUsageOptions message. Does not implicitly verify messages.

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

KeyUsageOptions 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 KeyUsageOptions message, length delimited. Does not implicitly verify messages.

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

KeyUsageOptions 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.KeyUsage.KeyUsageOptions}

Creates a KeyUsageOptions 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.KeyUsage.KeyUsageOptions

KeyUsageOptions

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for KeyUsageOptions

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 KeyUsageOptions message. Also converts values to other types if specified.

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

KeyUsageOptions

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a KeyUsageOptions 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