Class: ServiceAccountSpec
identity.v1.ServiceAccountSpec
Represents a ServiceAccountSpec.
Properties
access
• Optional access: null | $Properties
Note: one of Access or NamespaceScopedAccess must be provided, but not both.
The access assigned to the service account.
If set, creates an account scoped service account.
The access is mutable.
description
• description: string
The description associated with the service account - optional. The description is mutable.
name
• name: string
The name associated with the service account. The name is mutable, but must be unique across all your active service accounts.
namespaceScopedAccess
• Optional namespaceScopedAccess: null | $Properties
The namespace scoped access assigned to the service account.
If set, creates a namespace scoped service account (limited to a single namespace).
The namespace scoped access is partially mutable.
Refer to NamespaceScopedAccess for details.
Methods
toJSON
▸ toJSON(): Object
Converts this ServiceAccountSpec to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ServiceAccountSpec & $Properties
Creates a new ServiceAccountSpec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ServiceAccountSpec & $Properties
ServiceAccountSpec instance
▸ create(properties?): ServiceAccountSpec
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ServiceAccountSpec & $Properties
Decodes a ServiceAccountSpec message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
ServiceAccountSpec & $Properties
ServiceAccountSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ServiceAccountSpec & $Properties
Decodes a ServiceAccountSpec message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ServiceAccountSpec & $Properties
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
| Name | Type | Description |
|---|---|---|
message | $Properties | ServiceAccountSpec message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | $Properties | ServiceAccountSpec message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ServiceAccountSpec
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ServiceAccountSpec message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ServiceAccountSpec | ServiceAccountSpec |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object