Class AddControlRequest (2.48.0)

public final class AddControlRequest extends GeneratedMessageV3 implements AddControlRequestOrBuilder

Request for AddControl method.

Protobuf type google.cloud.retail.v2.AddControlRequest

Static Fields

CONTROL_ID_FIELD_NUMBER

public static final int CONTROL_ID_FIELD_NUMBER
Field Value
Type Description
int

SERVING_CONFIG_FIELD_NUMBER

public static final int SERVING_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AddControlRequest getDefaultInstance()
Returns
Type Description
AddControlRequest

getDescriptor()

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

newBuilder()

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

newBuilder(AddControlRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getControlId()

public String getControlId()

Required. The id of the control to apply. Assumed to be in the same catalog as the serving config - if id is not found a NOT_FOUND error is returned.

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

Returns
Type Description
String

The controlId.

getControlIdBytes()

public ByteString getControlIdBytes()

Required. The id of the control to apply. Assumed to be in the same catalog as the serving config - if id is not found a NOT_FOUND error is returned.

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

Returns
Type Description
ByteString

The bytes for controlId.

getDefaultInstanceForType()

public AddControlRequest getDefaultInstanceForType()
Returns
Type Description
AddControlRequest

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServingConfig()

public String getServingConfig()

Required. The source ServingConfig resource name . Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}

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

Returns
Type Description
String

The servingConfig.

getServingConfigBytes()

public ByteString getServingConfigBytes()

Required. The source ServingConfig resource name . Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}

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

Returns
Type Description
ByteString

The bytes for servingConfig.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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