Class CreateControlRequest (2.11.0)

public final class CreateControlRequest extends GeneratedMessageV3 implements CreateControlRequestOrBuilder

Request for CreateControl method.

Protobuf type google.cloud.retail.v2.CreateControlRequest

Static Fields

CONTROL_FIELD_NUMBER

public static final int CONTROL_FIELD_NUMBER
Field Value
TypeDescription
int

CONTROL_ID_FIELD_NUMBER

public static final int CONTROL_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateControlRequest getDefaultInstance()
Returns
TypeDescription
CreateControlRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CreateControlRequest.Builder newBuilder()
Returns
TypeDescription
CreateControlRequest.Builder

newBuilder(CreateControlRequest prototype)

public static CreateControlRequest.Builder newBuilder(CreateControlRequest prototype)
Parameter
NameDescription
prototypeCreateControlRequest
Returns
TypeDescription
CreateControlRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateControlRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateControlRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateControlRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateControlRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateControlRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateControlRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateControlRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateControlRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateControlRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateControlRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateControlRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateControlRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateControlRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateControlRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateControlRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateControlRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateControlRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateControlRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateControlRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateControlRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateControlRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateControlRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateControlRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateControlRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateControlRequest> parser()
Returns
TypeDescription
Parser<CreateControlRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getControl()

public Control getControl()

Required. The Control to create.

.google.cloud.retail.v2.Control control = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Control

The control.

getControlId()

public String getControlId()

Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.

string control_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The controlId.

getControlIdBytes()

public ByteString getControlIdBytes()

Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.

string control_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for controlId.

getControlOrBuilder()

public ControlOrBuilder getControlOrBuilder()

Required. The Control to create.

.google.cloud.retail.v2.Control control = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ControlOrBuilder

getDefaultInstanceForType()

public CreateControlRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateControlRequest

getParent()

public String getParent()

Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateControlRequest> getParserForType()
Returns
TypeDescription
Parser<CreateControlRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasControl()

public boolean hasControl()

Required. The Control to create.

.google.cloud.retail.v2.Control control = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the control field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateControlRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateControlRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateControlRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateControlRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateControlRequest.Builder toBuilder()
Returns
TypeDescription
CreateControlRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException