Class AddControlRequest.Builder (2.85.0)

public static final class AddControlRequest.Builder extends GeneratedMessage.Builder<AddControlRequest.Builder> implements AddControlRequestOrBuilder

Request for AddControl method.

Protobuf type google.cloud.retail.v2.AddControlRequest

Static Methods

getDescriptor()

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

Methods

build()

public AddControlRequest build()
Returns
Type Description
AddControlRequest

buildPartial()

public AddControlRequest buildPartial()
Returns
Type Description
AddControlRequest

clear()

public AddControlRequest.Builder clear()
Returns
Type Description
AddControlRequest.Builder
Overrides

clearControlId()

public AddControlRequest.Builder clearControlId()

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
AddControlRequest.Builder

This builder for chaining.

clearServingConfig()

public AddControlRequest.Builder clearServingConfig()

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
AddControlRequest.Builder

This builder for chaining.

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AddControlRequest other)

public AddControlRequest.Builder mergeFrom(AddControlRequest other)
Parameter
Name Description
other AddControlRequest
Returns
Type Description
AddControlRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AddControlRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AddControlRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AddControlRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AddControlRequest.Builder
Overrides

setControlId(String value)

public AddControlRequest.Builder setControlId(String value)

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];

Parameter
Name Description
value String

The controlId to set.

Returns
Type Description
AddControlRequest.Builder

This builder for chaining.

setControlIdBytes(ByteString value)

public AddControlRequest.Builder setControlIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for controlId to set.

Returns
Type Description
AddControlRequest.Builder

This builder for chaining.

setServingConfig(String value)

public AddControlRequest.Builder setServingConfig(String value)

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) = { ... }

Parameter
Name Description
value String

The servingConfig to set.

Returns
Type Description
AddControlRequest.Builder

This builder for chaining.

setServingConfigBytes(ByteString value)

public AddControlRequest.Builder setServingConfigBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for servingConfig to set.

Returns
Type Description
AddControlRequest.Builder

This builder for chaining.