Class CreateProductRequest.Builder (2.22.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.v2.CreateProductRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateProductRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CreateProductRequest.Builder
Overrides

build()

public CreateProductRequest build()
Returns
TypeDescription
CreateProductRequest

buildPartial()

public CreateProductRequest buildPartial()
Returns
TypeDescription
CreateProductRequest

clear()

public CreateProductRequest.Builder clear()
Returns
TypeDescription
CreateProductRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public CreateProductRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CreateProductRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateProductRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
CreateProductRequest.Builder

This builder for chaining.

clearProduct()

public CreateProductRequest.Builder clearProduct()

Required. The Product to create.

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

Returns
TypeDescription
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
TypeDescription
CreateProductRequest.Builder

This builder for chaining.

clone()

public CreateProductRequest.Builder clone()
Returns
TypeDescription
CreateProductRequest.Builder
Overrides

getDefaultInstanceForType()

public CreateProductRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateProductRequest

getDescriptorForType()

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

The bytes for parent.

getProduct()

public Product getProduct()

Required. The Product to create.

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

Returns
TypeDescription
Product

The product.

getProductBuilder()

public Product.Builder getProductBuilder()

Required. The Product to create.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for productId.

getProductOrBuilder()

public ProductOrBuilder getProductOrBuilder()

Required. The Product to create.

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

Returns
TypeDescription
ProductOrBuilder

hasProduct()

public boolean hasProduct()

Required. The Product to create.

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

Returns
TypeDescription
boolean

Whether the product field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CreateProductRequest other)

public CreateProductRequest.Builder mergeFrom(CreateProductRequest other)
Parameter
NameDescription
otherCreateProductRequest
Returns
TypeDescription
CreateProductRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateProductRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateProductRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CreateProductRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CreateProductRequest.Builder
Overrides

mergeProduct(Product value)

public CreateProductRequest.Builder mergeProduct(Product value)

Required. The Product to create.

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

Parameter
NameDescription
valueProduct
Returns
TypeDescription
CreateProductRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateProductRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CreateProductRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public CreateProductRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
CreateProductRequest.Builder

This builder for chaining.

setProduct(Product value)

public CreateProductRequest.Builder setProduct(Product value)

Required. The Product to create.

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

Parameter
NameDescription
valueProduct
Returns
TypeDescription
CreateProductRequest.Builder

setProduct(Product.Builder builderForValue)

public CreateProductRequest.Builder setProduct(Product.Builder builderForValue)

Required. The Product to create.

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

Parameter
NameDescription
builderForValueProduct.Builder
Returns
TypeDescription
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
NameDescription
valueString

The productId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for productId to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CreateProductRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateProductRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CreateProductRequest.Builder
Overrides