Class CreateProductRequest.Builder (2.55.0)

public static final class CreateProductRequest.Builder extends GeneratedMessageV3.Builder<CreateProductRequest.Builder> implements CreateProductRequestOrBuilder

Request message for ProductService.CreateProduct method.

Protobuf type google.cloud.retail.v2alpha.CreateProductRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateProductRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateProductRequest.Builder
Overrides

build()

public CreateProductRequest build()
Returns
Type Description
CreateProductRequest

buildPartial()

public CreateProductRequest buildPartial()
Returns
Type Description
CreateProductRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

public CreateProductRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CreateProductRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateProductRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CreateProductRequest.Builder
Overrides

clearParent()

public CreateProductRequest.Builder clearParent()

Required. The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch.

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

Returns
Type Description
CreateProductRequest.Builder

This builder for chaining.

clearProduct()

public CreateProductRequest.Builder clearProduct()

Required. The Product to create.

.google.cloud.retail.v2alpha.Product product = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateProductRequest.Builder

clearProductId()

public CreateProductRequest.Builder clearProductId()

Required. The ID to use for the Product, which will become the final component of the Product.name.

If the caller does not have permission to create the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is returned.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

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

Returns
Type Description
CreateProductRequest.Builder

This builder for chaining.

clone()

public CreateProductRequest.Builder clone()
Returns
Type Description
CreateProductRequest.Builder
Overrides

getDefaultInstanceForType()

public CreateProductRequest getDefaultInstanceForType()
Returns
Type Description
CreateProductRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getParent()

public String getParent()

Required. The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch.

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

Returns
Type Description
ByteString

The bytes for parent.

getProduct()

public Product getProduct()

Required. The Product to create.

.google.cloud.retail.v2alpha.Product product = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Product

The product.

getProductBuilder()

public Product.Builder getProductBuilder()

Required. The Product to create.

.google.cloud.retail.v2alpha.Product product = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Product.Builder

getProductId()

public String getProductId()

Required. The ID to use for the Product, which will become the final component of the Product.name.

If the caller does not have permission to create the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is returned.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

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

Returns
Type Description
String

The productId.

getProductIdBytes()

public ByteString getProductIdBytes()

Required. The ID to use for the Product, which will become the final component of the Product.name.

If the caller does not have permission to create the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is returned.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

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

Returns
Type Description
ByteString

The bytes for productId.

getProductOrBuilder()

public ProductOrBuilder getProductOrBuilder()

Required. The Product to create.

.google.cloud.retail.v2alpha.Product product = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProductOrBuilder

hasProduct()

public boolean hasProduct()

Required. The Product to create.

.google.cloud.retail.v2alpha.Product product = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the product field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CreateProductRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeProduct(Product value)

public CreateProductRequest.Builder mergeProduct(Product value)

Required. The Product to create.

.google.cloud.retail.v2alpha.Product product = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Product
Returns
Type Description
CreateProductRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateProductRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateProductRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public CreateProductRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateProductRequest.Builder
Overrides

setParent(String value)

public CreateProductRequest.Builder setParent(String value)

Required. The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateProductRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateProductRequest.Builder setParentBytes(ByteString value)

Required. The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch.

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateProductRequest.Builder

This builder for chaining.

setProduct(Product value)

public CreateProductRequest.Builder setProduct(Product value)

Required. The Product to create.

.google.cloud.retail.v2alpha.Product product = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Product
Returns
Type Description
CreateProductRequest.Builder

setProduct(Product.Builder builderForValue)

public CreateProductRequest.Builder setProduct(Product.Builder builderForValue)

Required. The Product to create.

.google.cloud.retail.v2alpha.Product product = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Product.Builder
Returns
Type Description
CreateProductRequest.Builder

setProductId(String value)

public CreateProductRequest.Builder setProductId(String value)

Required. The ID to use for the Product, which will become the final component of the Product.name.

If the caller does not have permission to create the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is returned.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

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

Parameter
Name Description
value String

The productId to set.

Returns
Type Description
CreateProductRequest.Builder

This builder for chaining.

setProductIdBytes(ByteString value)

public CreateProductRequest.Builder setProductIdBytes(ByteString value)

Required. The ID to use for the Product, which will become the final component of the Product.name.

If the caller does not have permission to create the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is returned.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

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

Parameter
Name Description
value ByteString

The bytes for productId to set.

Returns
Type Description
CreateProductRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CreateProductRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CreateProductRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateProductRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateProductRequest.Builder
Overrides