Class CancelOrderRequest (0.51.0)

public final class CancelOrderRequest extends GeneratedMessageV3 implements CancelOrderRequestOrBuilder

Request message for ConsumerProcurementService.CancelOrder.

Protobuf type google.cloud.commerce.consumer.procurement.v1.CancelOrderRequest

Static Fields

CANCELLATION_POLICY_FIELD_NUMBER

public static final int CANCELLATION_POLICY_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CancelOrderRequest getDefaultInstance()
Returns
Type Description
CancelOrderRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CancelOrderRequest.Builder newBuilder()
Returns
Type Description
CancelOrderRequest.Builder

newBuilder(CancelOrderRequest prototype)

public static CancelOrderRequest.Builder newBuilder(CancelOrderRequest prototype)
Parameter
Name Description
prototype CancelOrderRequest
Returns
Type Description
CancelOrderRequest.Builder

parseDelimitedFrom(InputStream input)

public static CancelOrderRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CancelOrderRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CancelOrderRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CancelOrderRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CancelOrderRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CancelOrderRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CancelOrderRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CancelOrderRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CancelOrderRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CancelOrderRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CancelOrderRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CancelOrderRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CancelOrderRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CancelOrderRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CancelOrderRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CancelOrderRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CancelOrderRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CancelOrderRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CancelOrderRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CancelOrderRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CancelOrderRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CancelOrderRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CancelOrderRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CancelOrderRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CancelOrderRequest> parser()
Returns
Type Description
Parser<CancelOrderRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCancellationPolicy()

public CancelOrderRequest.CancellationPolicy getCancellationPolicy()

Optional. Cancellation policy of this request.

.google.cloud.commerce.consumer.procurement.v1.CancelOrderRequest.CancellationPolicy cancellation_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CancelOrderRequest.CancellationPolicy

The cancellationPolicy.

getCancellationPolicyValue()

public int getCancellationPolicyValue()

Optional. Cancellation policy of this request.

.google.cloud.commerce.consumer.procurement.v1.CancelOrderRequest.CancellationPolicy cancellation_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for cancellationPolicy.

getDefaultInstanceForType()

public CancelOrderRequest getDefaultInstanceForType()
Returns
Type Description
CancelOrderRequest

getEtag()

public String getEtag()

Optional. The weak etag, which can be optionally populated, of the order that this cancel request is based on. Validation checking will only happen if the invoker supplies this field.

string etag = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Optional. The weak etag, which can be optionally populated, of the order that this cancel request is based on. Validation checking will only happen if the invoker supplies this field.

string etag = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for etag.

getName()

public String getName()

Required. The resource name of the order.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the order.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<CancelOrderRequest> getParserForType()
Returns
Type Description
Parser<CancelOrderRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CancelOrderRequest.Builder newBuilderForType()
Returns
Type Description
CancelOrderRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CancelOrderRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CancelOrderRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CancelOrderRequest.Builder toBuilder()
Returns
Type Description
CancelOrderRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException