Class UpdateCatalogRequest.Builder (2.2.0)

public static final class UpdateCatalogRequest.Builder extends GeneratedMessageV3.Builder<UpdateCatalogRequest.Builder> implements UpdateCatalogRequestOrBuilder

Request for CatalogService.UpdateCatalog method.

Protobuf type google.cloud.retail.v2.UpdateCatalogRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public UpdateCatalogRequest build()
Returns
TypeDescription
UpdateCatalogRequest

buildPartial()

public UpdateCatalogRequest buildPartial()
Returns
TypeDescription
UpdateCatalogRequest

clear()

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

clearCatalog()

public UpdateCatalogRequest.Builder clearCatalog()

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.v2.Catalog catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
UpdateCatalogRequest.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateCatalogRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
UpdateCatalogRequest.Builder
Overrides

clearUpdateMask()

public UpdateCatalogRequest.Builder clearUpdateMask()

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
UpdateCatalogRequest.Builder

clone()

public UpdateCatalogRequest.Builder clone()
Returns
TypeDescription
UpdateCatalogRequest.Builder
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.v2.Catalog catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Catalog

The catalog.

getCatalogBuilder()

public Catalog.Builder getCatalogBuilder()

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.v2.Catalog catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Catalog.Builder

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.v2.Catalog catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
CatalogOrBuilder

getDefaultInstanceForType()

public UpdateCatalogRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateCatalogRequest

getDescriptorForType()

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

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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
Builder

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.v2.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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCatalog(Catalog value)

public UpdateCatalogRequest.Builder mergeCatalog(Catalog value)

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.v2.Catalog catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueCatalog
Returns
TypeDescription
UpdateCatalogRequest.Builder

mergeFrom(UpdateCatalogRequest other)

public UpdateCatalogRequest.Builder mergeFrom(UpdateCatalogRequest other)
Parameter
NameDescription
otherUpdateCatalogRequest
Returns
TypeDescription
UpdateCatalogRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateMask(FieldMask value)

public UpdateCatalogRequest.Builder mergeUpdateMask(FieldMask value)

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;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
UpdateCatalogRequest.Builder

setCatalog(Catalog value)

public UpdateCatalogRequest.Builder setCatalog(Catalog value)

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.v2.Catalog catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueCatalog
Returns
TypeDescription
UpdateCatalogRequest.Builder

setCatalog(Catalog.Builder builderForValue)

public UpdateCatalogRequest.Builder setCatalog(Catalog.Builder builderForValue)

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.v2.Catalog catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueCatalog.Builder
Returns
TypeDescription
UpdateCatalogRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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

public UpdateCatalogRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
UpdateCatalogRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateMask(FieldMask value)

public UpdateCatalogRequest.Builder setUpdateMask(FieldMask value)

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;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
UpdateCatalogRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateCatalogRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
UpdateCatalogRequest.Builder