Class CreateProductRequest (2.44.0)

public final class CreateProductRequest extends GeneratedMessageV3 implements CreateProductRequestOrBuilder

Request message for ProductService.CreateProduct method.

Protobuf type google.cloud.retail.v2.CreateProductRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_FIELD_NUMBER

public static final int PRODUCT_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_ID_FIELD_NUMBER

public static final int PRODUCT_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateProductRequest getDefaultInstance()
Returns
Type Description
CreateProductRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateProductRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CreateProductRequest getDefaultInstanceForType()
Returns
Type Description
CreateProductRequest

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.

getParserForType()

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

getProduct()

public Product getProduct()

Required. The Product to create.

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

Returns
Type Description
Product

The product.

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.v2.Product product = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProductOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasProduct()

public boolean hasProduct()

Required. The Product to create.

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

Returns
Type Description
boolean

Whether the product 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 CreateProductRequest.Builder newBuilderForType()
Returns
Type Description
CreateProductRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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