Interface OrderOrBuilder (0.29.0)

public interface OrderOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. Labels associated with this order as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getAcceptedTime()

public abstract Timestamp getAcceptedTime()

Output only. The time when the order was moved to ACCEPTED state.

.google.protobuf.Timestamp accepted_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The acceptedTime.

getAcceptedTimeOrBuilder()

public abstract TimestampOrBuilder getAcceptedTimeOrBuilder()

Output only. The time when the order was moved to ACCEPTED state.

.google.protobuf.Timestamp accepted_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getActualInstallationDate()

public abstract Date getActualInstallationDate()

Output only. Actual installation date for this order.

.google.type.Date actual_installation_date = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Date

The actualInstallationDate.

getActualInstallationDateOrBuilder()

public abstract DateOrBuilder getActualInstallationDateOrBuilder()

Output only. Actual installation date for this order.

.google.type.Date actual_installation_date = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.DateOrBuilder

getBillingId()

public abstract String getBillingId()

Output only. The Google Cloud Billing ID to be charged for this order.

string billing_id = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The billingId.

getBillingIdBytes()

public abstract ByteString getBillingIdBytes()

Output only. The Google Cloud Billing ID to be charged for this order.

string billing_id = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for billingId.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Time when this order was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when this order was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCustomerMotivation()

public abstract String getCustomerMotivation()

Required. Information about the customer's motivation for this order. The length of this field must be <= 1000 characters.

string customer_motivation = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The customerMotivation.

getCustomerMotivationBytes()

public abstract ByteString getCustomerMotivationBytes()

Required. Information about the customer's motivation for this order. The length of this field must be <= 1000 characters.

string customer_motivation = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for customerMotivation.

getCustomerRequestedInstallationDate()

public abstract Date getCustomerRequestedInstallationDate()

Optional. Customer requested installation date for this order.

.google.type.Date customer_requested_installation_date = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.Date

The customerRequestedInstallationDate.

getCustomerRequestedInstallationDateOrBuilder()

public abstract DateOrBuilder getCustomerRequestedInstallationDateOrBuilder()

Optional. Customer requested installation date for this order.

.google.type.Date customer_requested_installation_date = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DateOrBuilder

getDeploymentType()

public abstract Order.DeploymentType getDeploymentType()

Output only. The deployment type of this order.

.google.cloud.gdchardwaremanagement.v1alpha.Order.DeploymentType deployment_type = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Order.DeploymentType

The deploymentType.

getDeploymentTypeValue()

public abstract int getDeploymentTypeValue()

Output only. The deployment type of this order.

.google.cloud.gdchardwaremanagement.v1alpha.Order.DeploymentType deployment_type = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for deploymentType.

getDisplayName()

public abstract String getDisplayName()

Optional. Display name of this order.

string display_name = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. Display name of this order.

string display_name = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getEstimatedDeliveryDate()

public abstract Date getEstimatedDeliveryDate()

Output only. Estimated delivery date for this order.

.google.type.Date estimated_delivery_date = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Date

The estimatedDeliveryDate.

getEstimatedDeliveryDateOrBuilder()

public abstract DateOrBuilder getEstimatedDeliveryDateOrBuilder()

Output only. Estimated delivery date for this order.

.google.type.Date estimated_delivery_date = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.DateOrBuilder

getEstimatedInstallationDate()

public abstract Date getEstimatedInstallationDate()

Output only. Estimated installation date for this order.

.google.type.Date estimated_installation_date = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Date

The estimatedInstallationDate.

getEstimatedInstallationDateOrBuilder()

public abstract DateOrBuilder getEstimatedInstallationDateOrBuilder()

Output only. Estimated installation date for this order.

.google.type.Date estimated_installation_date = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.DateOrBuilder

getExistingHardware(int index)

public abstract HardwareLocation getExistingHardware(int index)

Optional. Existing hardware to be removed as part of this order. Note: any hardware removed will be recycled unless otherwise agreed.

repeated .google.cloud.gdchardwaremanagement.v1alpha.HardwareLocation existing_hardware = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
HardwareLocation

getExistingHardwareCount()

public abstract int getExistingHardwareCount()

Optional. Existing hardware to be removed as part of this order. Note: any hardware removed will be recycled unless otherwise agreed.

repeated .google.cloud.gdchardwaremanagement.v1alpha.HardwareLocation existing_hardware = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getExistingHardwareList()

public abstract List<HardwareLocation> getExistingHardwareList()

Optional. Existing hardware to be removed as part of this order. Note: any hardware removed will be recycled unless otherwise agreed.

repeated .google.cloud.gdchardwaremanagement.v1alpha.HardwareLocation existing_hardware = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<HardwareLocation>

getExistingHardwareOrBuilder(int index)

public abstract HardwareLocationOrBuilder getExistingHardwareOrBuilder(int index)

Optional. Existing hardware to be removed as part of this order. Note: any hardware removed will be recycled unless otherwise agreed.

repeated .google.cloud.gdchardwaremanagement.v1alpha.HardwareLocation existing_hardware = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
HardwareLocationOrBuilder

getExistingHardwareOrBuilderList()

public abstract List<? extends HardwareLocationOrBuilder> getExistingHardwareOrBuilderList()

Optional. Existing hardware to be removed as part of this order. Note: any hardware removed will be recycled unless otherwise agreed.

repeated .google.cloud.gdchardwaremanagement.v1alpha.HardwareLocation existing_hardware = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.gdchardwaremanagement.v1alpha.HardwareLocationOrBuilder>

getFulfillmentTime() (deprecated)

public abstract Timestamp getFulfillmentTime()

Deprecated. google.cloud.gdchardwaremanagement.v1alpha.Order.fulfillment_time is deprecated. See google/cloud/gdchardwaremanagement/v1alpha/resources.proto;l=190

Deprecated: Please use customer_requested_installation_date instead.

.google.protobuf.Timestamp fulfillment_time = 9 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The fulfillmentTime.

getFulfillmentTimeOrBuilder() (deprecated)

public abstract TimestampOrBuilder getFulfillmentTimeOrBuilder()

Deprecated: Please use customer_requested_installation_date instead.

.google.protobuf.Timestamp fulfillment_time = 9 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. Labels associated with this order as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. Labels associated with this order as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels associated with this order as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. Labels associated with this order as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMigration()

public abstract boolean getMigration()

Optional. Whether this order is a migration from customer's existing infrastructure.

bool migration = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The migration.

getName()

public abstract String getName()

Identifier. Name of this order. Format: projects/{project}/locations/{location}/orders/{order}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. Name of this order. Format: projects/{project}/locations/{location}/orders/{order}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getOrderFormUri()

public abstract String getOrderFormUri()

Output only. Link to the order form.

string order_form_uri = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The orderFormUri.

getOrderFormUriBytes()

public abstract ByteString getOrderFormUriBytes()

Output only. Link to the order form.

string order_form_uri = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for orderFormUri.

getOrganizationContact()

public abstract OrganizationContact getOrganizationContact()

Required. Customer contact information.

.google.cloud.gdchardwaremanagement.v1alpha.OrganizationContact organization_contact = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OrganizationContact

The organizationContact.

getOrganizationContactOrBuilder()

public abstract OrganizationContactOrBuilder getOrganizationContactOrBuilder()

Required. Customer contact information.

.google.cloud.gdchardwaremanagement.v1alpha.OrganizationContact organization_contact = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OrganizationContactOrBuilder

getRegionCode()

public abstract String getRegionCode()

Required. Unicode CLDR region code where this order will be deployed. For a list of valid CLDR region codes, see the Language Subtag Registry.

string region_code = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The regionCode.

getRegionCodeBytes()

public abstract ByteString getRegionCodeBytes()

Required. Unicode CLDR region code where this order will be deployed. For a list of valid CLDR region codes, see the Language Subtag Registry.

string region_code = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for regionCode.

getRequestedDateChange()

public abstract Date getRequestedDateChange()

Output only. The date to which the customer or Google wants to set the scheduled installation date.

.google.type.Date requested_date_change = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Date

The requestedDateChange.

getRequestedDateChangeOrBuilder()

public abstract DateOrBuilder getRequestedDateChangeOrBuilder()

Output only. The date to which the customer or Google wants to set the scheduled installation date.

.google.type.Date requested_date_change = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.DateOrBuilder

getState()

public abstract Order.State getState()

Output only. State of this order. On order creation, state will be set to DRAFT.

.google.cloud.gdchardwaremanagement.v1alpha.Order.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Order.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. State of this order. On order creation, state will be set to DRAFT.

.google.cloud.gdchardwaremanagement.v1alpha.Order.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getSubmitTime()

public abstract Timestamp getSubmitTime()

Output only. Time when the order was submitted. Is auto-populated to the current time when an order is submitted.

.google.protobuf.Timestamp submit_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The submitTime.

getSubmitTimeOrBuilder()

public abstract TimestampOrBuilder getSubmitTimeOrBuilder()

Output only. Time when the order was submitted. Is auto-populated to the current time when an order is submitted.

.google.protobuf.Timestamp submit_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getTargetWorkloads(int index)

public abstract String getTargetWorkloads(int index)

Optional. Customer specified workloads of interest targeted by this order. This must contain <= 20 elements and the length of each element must be <= 50 characters.

repeated string target_workloads = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The targetWorkloads at the given index.

getTargetWorkloadsBytes(int index)

public abstract ByteString getTargetWorkloadsBytes(int index)

Optional. Customer specified workloads of interest targeted by this order. This must contain <= 20 elements and the length of each element must be <= 50 characters.

repeated string target_workloads = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the targetWorkloads at the given index.

getTargetWorkloadsCount()

public abstract int getTargetWorkloadsCount()

Optional. Customer specified workloads of interest targeted by this order. This must contain <= 20 elements and the length of each element must be <= 50 characters.

repeated string target_workloads = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of targetWorkloads.

getTargetWorkloadsList()

public abstract List<String> getTargetWorkloadsList()

Optional. Customer specified workloads of interest targeted by this order. This must contain <= 20 elements and the length of each element must be <= 50 characters.

repeated string target_workloads = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the targetWorkloads.

getType()

public abstract Order.Type getType()

Output only. Type of this Order.

.google.cloud.gdchardwaremanagement.v1alpha.Order.Type type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Order.Type

The type.

getTypeValue()

public abstract int getTypeValue()

Output only. Type of this Order.

.google.cloud.gdchardwaremanagement.v1alpha.Order.Type type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for type.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Time when this order was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time when this order was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getVendorContact()

public abstract OrganizationContact getVendorContact()

Output only. Contact information of the SI assigned to this order.

.google.cloud.gdchardwaremanagement.v1alpha.OrganizationContact vendor_contact = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OrganizationContact

The vendorContact.

getVendorContactOrBuilder()

public abstract OrganizationContactOrBuilder getVendorContactOrBuilder()

Output only. Contact information of the SI assigned to this order.

.google.cloud.gdchardwaremanagement.v1alpha.OrganizationContact vendor_contact = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OrganizationContactOrBuilder

getVendorNotes()

public abstract String getVendorNotes()

Output only. Notes for this order, provided by the vendor.

string vendor_notes = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The vendorNotes.

getVendorNotesBytes()

public abstract ByteString getVendorNotesBytes()

Output only. Notes for this order, provided by the vendor.

string vendor_notes = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for vendorNotes.

hasAcceptedTime()

public abstract boolean hasAcceptedTime()

Output only. The time when the order was moved to ACCEPTED state.

.google.protobuf.Timestamp accepted_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the acceptedTime field is set.

hasActualInstallationDate()

public abstract boolean hasActualInstallationDate()

Output only. Actual installation date for this order.

.google.type.Date actual_installation_date = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the actualInstallationDate field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Time when this order was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasCustomerRequestedInstallationDate()

public abstract boolean hasCustomerRequestedInstallationDate()

Optional. Customer requested installation date for this order.

.google.type.Date customer_requested_installation_date = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the customerRequestedInstallationDate field is set.

hasEstimatedDeliveryDate()

public abstract boolean hasEstimatedDeliveryDate()

Output only. Estimated delivery date for this order.

.google.type.Date estimated_delivery_date = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the estimatedDeliveryDate field is set.

hasEstimatedInstallationDate()

public abstract boolean hasEstimatedInstallationDate()

Output only. Estimated installation date for this order.

.google.type.Date estimated_installation_date = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the estimatedInstallationDate field is set.

hasFulfillmentTime() (deprecated)

public abstract boolean hasFulfillmentTime()

Deprecated. google.cloud.gdchardwaremanagement.v1alpha.Order.fulfillment_time is deprecated. See google/cloud/gdchardwaremanagement/v1alpha/resources.proto;l=190

Deprecated: Please use customer_requested_installation_date instead.

.google.protobuf.Timestamp fulfillment_time = 9 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the fulfillmentTime field is set.

hasOrganizationContact()

public abstract boolean hasOrganizationContact()

Required. Customer contact information.

.google.cloud.gdchardwaremanagement.v1alpha.OrganizationContact organization_contact = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the organizationContact field is set.

hasRequestedDateChange()

public abstract boolean hasRequestedDateChange()

Output only. The date to which the customer or Google wants to set the scheduled installation date.

.google.type.Date requested_date_change = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the requestedDateChange field is set.

hasSubmitTime()

public abstract boolean hasSubmitTime()

Output only. Time when the order was submitted. Is auto-populated to the current time when an order is submitted.

.google.protobuf.Timestamp submit_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the submitTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Time when this order was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hasVendorContact()

public abstract boolean hasVendorContact()

Output only. Contact information of the SI assigned to this order.

.google.cloud.gdchardwaremanagement.v1alpha.OrganizationContact vendor_contact = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the vendorContact field is set.