Class: CapacityModeOptions
v1.NamespaceCapacityInfo.CapacityModeOptions
Represents a CapacityModeOptions.
Implements
Constructors
constructor
• new CapacityModeOptions(properties?): CapacityModeOptions
Constructs a new CapacityModeOptions.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICapacityModeOptions | Properties to set |
Returns
Properties
onDemand
• Optional onDemand: null | IOnDemand
On-Demand capacity information.
Implementation of
provisioned
• Optional provisioned: null | IProvisioned
Provisioned capacity options and entitlements.
Implementation of
ICapacityModeOptions.provisioned
Methods
toJSON
▸ toJSON(): Object
Converts this CapacityModeOptions to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CapacityModeOptions
Creates a new CapacityModeOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICapacityModeOptions | Properties to set |
Returns
CapacityModeOptions instance
decode
▸ decode(reader, length?): CapacityModeOptions
Decodes a CapacityModeOptions 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
CapacityModeOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CapacityModeOptions
Decodes a CapacityModeOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CapacityModeOptions
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 CapacityModeOptions message. Does not implicitly temporal.api.cloud.namespace.v1.NamespaceCapacityInfo.CapacityModeOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICapacityModeOptions | CapacityModeOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CapacityModeOptions message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.NamespaceCapacityInfo.CapacityModeOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICapacityModeOptions | CapacityModeOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CapacityModeOptions
Creates a CapacityModeOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CapacityModeOptions
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for CapacityModeOptions
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a CapacityModeOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CapacityModeOptions | CapacityModeOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object