Class UpdateCatalogRequest (2.29.0)

public final class UpdateCatalogRequest extends GeneratedMessageV3 implements UpdateCatalogRequestOrBuilder

Request for CatalogService.UpdateCatalog method.

Protobuf type google.cloud.retail.v2alpha.UpdateCatalogRequest

Static Fields

CATALOG_FIELD_NUMBER

public static final int CATALOG_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UpdateCatalogRequest getDefaultInstance()
Returns
TypeDescription
UpdateCatalogRequest

getDescriptor()

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

newBuilder()

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

newBuilder(UpdateCatalogRequest prototype)

public static UpdateCatalogRequest.Builder newBuilder(UpdateCatalogRequest prototype)
Parameter
NameDescription
prototypeUpdateCatalogRequest
Returns
TypeDescription
UpdateCatalogRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCatalog()

public Catalog getCatalog()

Required. The Catalog to update.

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

If the Catalog to update does not exist, a NOT_FOUND error is returned.

.google.cloud.retail.v2alpha.Catalog catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Catalog

The catalog.

getCatalogOrBuilder()

public CatalogOrBuilder getCatalogOrBuilder()

Required. The Catalog to update.

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

If the Catalog to update does not exist, a NOT_FOUND error is returned.

.google.cloud.retail.v2alpha.Catalog catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
CatalogOrBuilder

getDefaultInstanceForType()

public UpdateCatalogRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateCatalogRequest

getParserForType()

public Parser<UpdateCatalogRequest> getParserForType()
Returns
TypeDescription
Parser<UpdateCatalogRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUpdateMask()

public FieldMask getUpdateMask()

Indicates which fields in the provided Catalog to update.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Indicates which fields in the provided Catalog to update.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
FieldMaskOrBuilder

hasCatalog()

public boolean hasCatalog()

Required. The Catalog to update.

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

If the Catalog to update does not exist, a NOT_FOUND error is returned.

.google.cloud.retail.v2alpha.Catalog catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the catalog field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Indicates which fields in the provided Catalog to update.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
boolean

Whether the updateMask 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 UpdateCatalogRequest.Builder newBuilderForType()
Returns
TypeDescription
UpdateCatalogRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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