Class CreateControlRequest (2.57.0)

public final class CreateControlRequest extends GeneratedMessageV3 implements CreateControlRequestOrBuilder

Request for CreateControl method.

Protobuf type google.cloud.retail.v2beta.CreateControlRequest

Static Fields

CONTROL_FIELD_NUMBER

public static final int CONTROL_FIELD_NUMBER
Field Value
Type Description
int

CONTROL_ID_FIELD_NUMBER

public static final int CONTROL_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateControlRequest getDefaultInstance()
Returns
Type Description
CreateControlRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateControlRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getControl()

public Control getControl()

Required. The Control to create.

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

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for controlId.

getControlOrBuilder()

public ControlOrBuilder getControlOrBuilder()

Required. The Control to create.

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

Returns
Type Description
ControlOrBuilder

getDefaultInstanceForType()

public CreateControlRequest getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasControl()

public boolean hasControl()

Required. The Control to create.

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

Returns
Type Description
boolean

Whether the control field is set.

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 CreateControlRequest.Builder newBuilderForType()
Returns
Type Description
CreateControlRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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