Class CreateProductRequest (2.39.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
TypeDescription
int

PRODUCT_FIELD_NUMBER

public static final int PRODUCT_FIELD_NUMBER
Field Value
TypeDescription
int

PRODUCT_ID_FIELD_NUMBER

public static final int PRODUCT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateProductRequest getDefaultInstance()
Returns
TypeDescription
CreateProductRequest

getDescriptor()

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

newBuilder()

public static CreateProductRequest.Builder newBuilder()
Returns
TypeDescription
CreateProductRequest.Builder

newBuilder(CreateProductRequest prototype)

public static CreateProductRequest.Builder newBuilder(CreateProductRequest prototype)
Parameter
NameDescription
prototypeCreateProductRequest
Returns
TypeDescription
CreateProductRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateProductRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateProductRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateProductRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateProductRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateProductRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateProductRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateProductRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateProductRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateProductRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateProductRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateProductRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateProductRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateProductRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateProductRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateProductRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateProductRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateProductRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateProductRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateProductRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateProductRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateProductRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateProductRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateProductRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateProductRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateProductRequest> parser()
Returns
TypeDescription
Parser<CreateProductRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CreateProductRequest getDefaultInstanceForType()
Returns
TypeDescription
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
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.

getParserForType()

public Parser<CreateProductRequest> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateProductRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateProductRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateProductRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateProductRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateProductRequest.Builder toBuilder()
Returns
TypeDescription
CreateProductRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException