Constructor
new CapacityCommitment(propertiesopt)
Constructs a new CapacityCommitment.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.bigquery.reservation.v1.ICapacityCommitment |
<optional> |
Properties to set |
- Implements:
-
- ICapacityCommitment
Members
commitmentEndTime
CapacityCommitment commitmentEndTime.
commitmentStartTime
CapacityCommitment commitmentStartTime.
edition
CapacityCommitment edition.
failureStatus
CapacityCommitment failureStatus.
multiRegionAuxiliary
CapacityCommitment multiRegionAuxiliary.
name
CapacityCommitment name.
plan
CapacityCommitment plan.
renewalPlan
CapacityCommitment renewalPlan.
slotCount
CapacityCommitment slotCount.
state
CapacityCommitment state.
CommitmentPlan
CommitmentPlan enum.
Properties:
| Name | Type | Description |
|---|---|---|
COMMITMENT_PLAN_UNSPECIFIED |
number |
COMMITMENT_PLAN_UNSPECIFIED value |
FLEX |
number |
FLEX value |
FLEX_FLAT_RATE |
number |
FLEX_FLAT_RATE value |
TRIAL |
number |
TRIAL value |
MONTHLY |
number |
MONTHLY value |
MONTHLY_FLAT_RATE |
number |
MONTHLY_FLAT_RATE value |
ANNUAL |
number |
ANNUAL value |
ANNUAL_FLAT_RATE |
number |
ANNUAL_FLAT_RATE value |
THREE_YEAR |
number |
THREE_YEAR value |
NONE |
number |
NONE value |
State
State enum.
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
number |
STATE_UNSPECIFIED value |
PENDING |
number |
PENDING value |
ACTIVE |
number |
ACTIVE value |
FAILED |
number |
FAILED value |
Methods
toJSON() → {Object.<string, *>}
Converts this CapacityCommitment to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.bigquery.reservation.v1.CapacityCommitment}
Creates a new CapacityCommitment instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.bigquery.reservation.v1.ICapacityCommitment |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.bigquery.reservation.v1.CapacityCommitment |
CapacityCommitment instance |
(static) decode(reader, lengthopt) → {google.cloud.bigquery.reservation.v1.CapacityCommitment}
Decodes a CapacityCommitment 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.bigquery.reservation.v1.CapacityCommitment |
CapacityCommitment |
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.bigquery.reservation.v1.CapacityCommitment}
Decodes a CapacityCommitment 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.bigquery.reservation.v1.CapacityCommitment |
CapacityCommitment |
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 CapacityCommitment message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.bigquery.reservation.v1.ICapacityCommitment |
CapacityCommitment 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 CapacityCommitment message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.bigquery.reservation.v1.ICapacityCommitment |
CapacityCommitment 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.bigquery.reservation.v1.CapacityCommitment}
Creates a CapacityCommitment 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.bigquery.reservation.v1.CapacityCommitment |
CapacityCommitment |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for CapacityCommitment
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 CapacityCommitment message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.bigquery.reservation.v1.CapacityCommitment |
CapacityCommitment |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a CapacityCommitment message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|