Skip to main content

Class: ServiceAccountSpec

identity.v1.ServiceAccountSpec

Represents a ServiceAccountSpec.

Implements

Constructors

constructor

new ServiceAccountSpec(properties?): ServiceAccountSpec

Constructs a new ServiceAccountSpec.

Parameters

NameTypeDescription
properties?IServiceAccountSpecProperties to set

Returns

ServiceAccountSpec

Properties

access

Optional access: null | IAccess

The access assigned to the service account. The access is mutable.

Implementation of

IServiceAccountSpec.access


description

description: string

The description associated with the service account - optional. The description is mutable.

Implementation of

IServiceAccountSpec.description


name

name: string

The name associated with the service account. The name is mutable, but must be unique across all your active service accounts.

Implementation of

IServiceAccountSpec.name

Methods

toJSON

toJSON(): Object

Converts this ServiceAccountSpec to JSON.

Returns

Object

JSON object


create

create(properties?): ServiceAccountSpec

Creates a new ServiceAccountSpec instance using the specified properties.

Parameters

NameTypeDescription
properties?IServiceAccountSpecProperties to set

Returns

ServiceAccountSpec

ServiceAccountSpec instance


decode

decode(reader, length?): ServiceAccountSpec

Decodes a ServiceAccountSpec message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

ServiceAccountSpec

ServiceAccountSpec

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ServiceAccountSpec

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ServiceAccountSpec

ServiceAccountSpec

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

Encodes the specified ServiceAccountSpec message. Does not implicitly temporal.api.cloud.identity.v1.ServiceAccountSpec.verify|verify messages.

Parameters

NameTypeDescription
messageIServiceAccountSpecServiceAccountSpec message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified ServiceAccountSpec message, length delimited. Does not implicitly temporal.api.cloud.identity.v1.ServiceAccountSpec.verify|verify messages.

Parameters

NameTypeDescription
messageIServiceAccountSpecServiceAccountSpec message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): ServiceAccountSpec

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ServiceAccountSpec

ServiceAccountSpec


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ServiceAccountSpec

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageServiceAccountSpecServiceAccountSpec
options?IConversionOptionsConversion options

Returns

Object

Plain object