Represents a CapacityCommitment.
Package
@google-cloud/bigquery-reservationConstructors
(constructor)(properties)
constructor(properties?: google.cloud.bigquery.reservation.v1.ICapacityCommitment);
Constructs a new CapacityCommitment.
Name | Description |
properties |
ICapacityCommitment
Properties to set |
Properties
commitmentEndTime
public commitmentEndTime?: (google.protobuf.ITimestamp|null);
CapacityCommitment commitmentEndTime.
commitmentStartTime
public commitmentStartTime?: (google.protobuf.ITimestamp|null);
CapacityCommitment commitmentStartTime.
failureStatus
public failureStatus?: (google.rpc.IStatus|null);
CapacityCommitment failureStatus.
name
public name: string;
CapacityCommitment name.
plan
public plan: (google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan|keyof typeof google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan);
CapacityCommitment plan.
renewalPlan
public renewalPlan: (google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan|keyof typeof google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan);
CapacityCommitment renewalPlan.
slotCount
public slotCount: (number|Long|string);
CapacityCommitment slotCount.
state
public state: (google.cloud.bigquery.reservation.v1.CapacityCommitment.State|keyof typeof google.cloud.bigquery.reservation.v1.CapacityCommitment.State);
CapacityCommitment state.
Methods
create(properties)
public static create(properties?: google.cloud.bigquery.reservation.v1.ICapacityCommitment): google.cloud.bigquery.reservation.v1.CapacityCommitment;
Creates a new CapacityCommitment instance using the specified properties.
Name | Description |
properties |
ICapacityCommitment
Properties to set |
Type | Description |
google.cloud.bigquery.reservation.v1.CapacityCommitment | CapacityCommitment instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.reservation.v1.CapacityCommitment;
Decodes a CapacityCommitment message from the specified reader or buffer.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Type | Description |
google.cloud.bigquery.reservation.v1.CapacityCommitment | CapacityCommitment |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.reservation.v1.CapacityCommitment;
Decodes a CapacityCommitment message from the specified reader or buffer, length delimited.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Type | Description |
google.cloud.bigquery.reservation.v1.CapacityCommitment | CapacityCommitment |
encode(message, writer)
public static encode(message: google.cloud.bigquery.reservation.v1.ICapacityCommitment, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified CapacityCommitment message. Does not implicitly messages.
Name | Description |
message |
ICapacityCommitment
CapacityCommitment message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.bigquery.reservation.v1.ICapacityCommitment, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified CapacityCommitment message, length delimited. Does not implicitly messages.
Name | Description |
message |
ICapacityCommitment
CapacityCommitment message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.bigquery.reservation.v1.CapacityCommitment;
Creates a CapacityCommitment message from a plain object. Also converts values to their respective internal types.
Name | Description |
object |
{ [k: string]: any }
Plain object |
Type | Description |
google.cloud.bigquery.reservation.v1.CapacityCommitment | CapacityCommitment |
toJSON()
public toJSON(): { [k: string]: any };
Converts this CapacityCommitment to JSON.
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.bigquery.reservation.v1.CapacityCommitment, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a CapacityCommitment message. Also converts values to other types if specified.
Name | Description |
message |
google.cloud.bigquery.reservation.v1.CapacityCommitment
CapacityCommitment |
options |
$protobuf.IConversionOptions
Conversion options |
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a CapacityCommitment message.
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) |
|