Represents an Order.
Package
@google-cloud/gdchardwaremanagementConstructors
(constructor)(properties)
constructor(properties?: google.cloud.gdchardwaremanagement.v1alpha.IOrder);Constructs a new Order.
| Parameter | |
|---|---|
| Name | Description | 
| properties | IOrderProperties to set | 
Properties
billingId
public billingId: string;Order billingId.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Order createTime.
customerMotivation
public customerMotivation: string;Order customerMotivation.
displayName
public displayName: string;Order displayName.
existingHardware
public existingHardware: google.cloud.gdchardwaremanagement.v1alpha.IHardwareLocation[];Order existingHardware.
fulfillmentTime
public fulfillmentTime?: (google.protobuf.ITimestamp|null);Order fulfillmentTime.
labels
public labels: { [k: string]: string };Order labels.
name
public name: string;Order name.
orderFormUri
public orderFormUri: string;Order orderFormUri.
organizationContact
public organizationContact?: (google.cloud.gdchardwaremanagement.v1alpha.IOrganizationContact|null);Order organizationContact.
regionCode
public regionCode: string;Order regionCode.
state
public state: (google.cloud.gdchardwaremanagement.v1alpha.Order.State|keyof typeof google.cloud.gdchardwaremanagement.v1alpha.Order.State);Order state.
submitTime
public submitTime?: (google.protobuf.ITimestamp|null);Order submitTime.
targetWorkloads
public targetWorkloads: string[];Order targetWorkloads.
type
public type: (google.cloud.gdchardwaremanagement.v1alpha.Order.Type|keyof typeof google.cloud.gdchardwaremanagement.v1alpha.Order.Type);Order type.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Order updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.gdchardwaremanagement.v1alpha.IOrder): google.cloud.gdchardwaremanagement.v1alpha.Order;Creates a new Order instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description | 
| properties | IOrderProperties to set | 
| Returns | |
|---|---|
| Type | Description | 
| Order | Order instance | 
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.gdchardwaremanagement.v1alpha.Order;Decodes an Order message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description | 
| reader | (Reader|Uint8Array)Reader or buffer to decode from | 
| length | numberMessage length if known beforehand | 
| Returns | |
|---|---|
| Type | Description | 
| Order | Order | 
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.gdchardwaremanagement.v1alpha.Order;Decodes an Order message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description | 
| reader | (Reader|Uint8Array)Reader or buffer to decode from | 
| Returns | |
|---|---|
| Type | Description | 
| Order | Order | 
encode(message, writer)
public static encode(message: google.cloud.gdchardwaremanagement.v1alpha.IOrder, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Order message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description | 
| message | IOrderOrder message or plain object to encode | 
| writer | $protobuf.WriterWriter to encode to | 
| Returns | |
|---|---|
| Type | Description | 
| $protobuf.Writer | Writer | 
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.gdchardwaremanagement.v1alpha.IOrder, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Order message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description | 
| message | IOrderOrder message or plain object to encode | 
| writer | $protobuf.WriterWriter to encode to | 
| Returns | |
|---|---|
| Type | Description | 
| $protobuf.Writer | Writer | 
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.gdchardwaremanagement.v1alpha.Order;Creates an Order message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description | 
| object | { [k: string]: any }Plain object | 
| Returns | |
|---|---|
| Type | Description | 
| Order | Order | 
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Order
| Parameter | |
|---|---|
| Name | Description | 
| typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") | 
| Returns | |
|---|---|
| Type | Description | 
| string | The default type url | 
toJSON()
public toJSON(): { [k: string]: any };Converts this Order to JSON.
| Returns | |
|---|---|
| Type | Description | 
| { [k: string]: any } | JSON object | 
toObject(message, options)
public static toObject(message: google.cloud.gdchardwaremanagement.v1alpha.Order, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an Order message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description | 
| message | OrderOrder | 
| options | $protobuf.IConversionOptionsConversion options | 
| Returns | |
|---|---|
| Type | Description | 
| { [k: string]: any } | Plain object | 
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an Order message.
| Parameter | |
|---|---|
| Name | Description | 
| message | { [k: string]: any }Plain object to verify | 
| Returns | |
|---|---|
| Type | Description | 
| (string|null) | 
 |