Class ProductSet.Builder (3.5.0)

public static final class ProductSet.Builder extends GeneratedMessageV3.Builder<ProductSet.Builder> implements ProductSetOrBuilder

A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.

Protobuf type google.cloud.vision.v1.ProductSet

Implements

ProductSetOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ProductSet build()
Returns
TypeDescription
ProductSet

buildPartial()

public ProductSet buildPartial()
Returns
TypeDescription
ProductSet

clear()

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

clearDisplayName()

public ProductSet.Builder clearDisplayName()

The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.

string display_name = 2;

Returns
TypeDescription
ProductSet.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearIndexError()

public ProductSet.Builder clearIndexError()

Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.

.google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ProductSet.Builder

clearIndexTime()

public ProductSet.Builder clearIndexTime()

Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet.

.google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ProductSet.Builder

clearName()

public ProductSet.Builder clearName()

The resource name of the ProductSet. Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID. This field is ignored when creating a ProductSet.

string name = 1;

Returns
TypeDescription
ProductSet.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getDefaultInstanceForType()

public ProductSet getDefaultInstanceForType()
Returns
TypeDescription
ProductSet

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.

string display_name = 2;

Returns
TypeDescription
ByteString

The bytes for displayName.

getIndexError()

public Status getIndexError()

Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.

.google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
com.google.rpc.Status

The indexError.

getIndexErrorBuilder()

public Status.Builder getIndexErrorBuilder()

Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.

.google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
com.google.rpc.Status.Builder

getIndexErrorOrBuilder()

public StatusOrBuilder getIndexErrorOrBuilder()

Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.

.google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
com.google.rpc.StatusOrBuilder

getIndexTime()

public Timestamp getIndexTime()

Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet.

.google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The indexTime.

getIndexTimeBuilder()

public Timestamp.Builder getIndexTimeBuilder()

Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet.

.google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getIndexTimeOrBuilder()

public TimestampOrBuilder getIndexTimeOrBuilder()

Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet.

.google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getName()

public String getName()

The resource name of the ProductSet. Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID. This field is ignored when creating a ProductSet.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the ProductSet. Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID. This field is ignored when creating a ProductSet.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

hasIndexError()

public boolean hasIndexError()

Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.

.google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the indexError field is set.

hasIndexTime()

public boolean hasIndexTime()

Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet.

.google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the indexTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ProductSet other)

public ProductSet.Builder mergeFrom(ProductSet other)
Parameter
NameDescription
otherProductSet
Returns
TypeDescription
ProductSet.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeIndexError(Status value)

public ProductSet.Builder mergeIndexError(Status value)

Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.

.google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valuecom.google.rpc.Status
Returns
TypeDescription
ProductSet.Builder

mergeIndexTime(Timestamp value)

public ProductSet.Builder mergeIndexTime(Timestamp value)

Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet.

.google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
ProductSet.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDisplayName(String value)

public ProductSet.Builder setDisplayName(String value)

The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.

string display_name = 2;

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
ProductSet.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ProductSet.Builder setDisplayNameBytes(ByteString value)

The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.

string display_name = 2;

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
ProductSet.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setIndexError(Status value)

public ProductSet.Builder setIndexError(Status value)

Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.

.google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valuecom.google.rpc.Status
Returns
TypeDescription
ProductSet.Builder

setIndexError(Status.Builder builderForValue)

public ProductSet.Builder setIndexError(Status.Builder builderForValue)

Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.

.google.rpc.Status index_error = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValuecom.google.rpc.Status.Builder
Returns
TypeDescription
ProductSet.Builder

setIndexTime(Timestamp value)

public ProductSet.Builder setIndexTime(Timestamp value)

Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet.

.google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
ProductSet.Builder

setIndexTime(Timestamp.Builder builderForValue)

public ProductSet.Builder setIndexTime(Timestamp.Builder builderForValue)

Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet.

.google.protobuf.Timestamp index_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ProductSet.Builder

setName(String value)

public ProductSet.Builder setName(String value)

The resource name of the ProductSet. Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID. This field is ignored when creating a ProductSet.

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
ProductSet.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ProductSet.Builder setNameBytes(ByteString value)

The resource name of the ProductSet. Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID. This field is ignored when creating a ProductSet.

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
ProductSet.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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