Class ImportMetadata.Builder (2.48.0)

public static final class ImportMetadata.Builder extends GeneratedMessageV3.Builder<ImportMetadata.Builder> implements ImportMetadataOrBuilder

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

Protobuf type google.cloud.retail.v2.ImportMetadata

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ImportMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ImportMetadata.Builder
Overrides

build()

public ImportMetadata build()
Returns
Type Description
ImportMetadata

buildPartial()

public ImportMetadata buildPartial()
Returns
Type Description
ImportMetadata

clear()

public ImportMetadata.Builder clear()
Returns
Type Description
ImportMetadata.Builder
Overrides

clearCreateTime()

public ImportMetadata.Builder clearCreateTime()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
ImportMetadata.Builder

clearFailureCount()

public ImportMetadata.Builder clearFailureCount()

Count of entries that encountered errors while processing.

int64 failure_count = 4;

Returns
Type Description
ImportMetadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ImportMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ImportMetadata.Builder
Overrides

clearNotificationPubsubTopic()

public ImportMetadata.Builder clearNotificationPubsubTopic()

Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}.

string notification_pubsub_topic = 6;

Returns
Type Description
ImportMetadata.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ImportMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ImportMetadata.Builder
Overrides

clearRequestId() (deprecated)

public ImportMetadata.Builder clearRequestId()

Deprecated. google.cloud.retail.v2.ImportMetadata.request_id is deprecated. See google/cloud/retail/v2/import_config.proto;l=336

Deprecated. This field is never set.

string request_id = 5 [deprecated = true];

Returns
Type Description
ImportMetadata.Builder

This builder for chaining.

clearSuccessCount()

public ImportMetadata.Builder clearSuccessCount()

Count of entries that were processed successfully.

int64 success_count = 3;

Returns
Type Description
ImportMetadata.Builder

This builder for chaining.

clearUpdateTime()

public ImportMetadata.Builder clearUpdateTime()

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Returns
Type Description
ImportMetadata.Builder

clone()

public ImportMetadata.Builder clone()
Returns
Type Description
ImportMetadata.Builder
Overrides

getCreateTime()

public Timestamp getCreateTime()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public ImportMetadata getDefaultInstanceForType()
Returns
Type Description
ImportMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFailureCount()

public long getFailureCount()

Count of entries that encountered errors while processing.

int64 failure_count = 4;

Returns
Type Description
long

The failureCount.

getNotificationPubsubTopic()

public String getNotificationPubsubTopic()

Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}.

string notification_pubsub_topic = 6;

Returns
Type Description
String

The notificationPubsubTopic.

getNotificationPubsubTopicBytes()

public ByteString getNotificationPubsubTopicBytes()

Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}.

string notification_pubsub_topic = 6;

Returns
Type Description
ByteString

The bytes for notificationPubsubTopic.

getRequestId() (deprecated)

public String getRequestId()

Deprecated. google.cloud.retail.v2.ImportMetadata.request_id is deprecated. See google/cloud/retail/v2/import_config.proto;l=336

Deprecated. This field is never set.

string request_id = 5 [deprecated = true];

Returns
Type Description
String

The requestId.

getRequestIdBytes() (deprecated)

public ByteString getRequestIdBytes()

Deprecated. google.cloud.retail.v2.ImportMetadata.request_id is deprecated. See google/cloud/retail/v2/import_config.proto;l=336

Deprecated. This field is never set.

string request_id = 5 [deprecated = true];

Returns
Type Description
ByteString

The bytes for requestId.

getSuccessCount()

public long getSuccessCount()

Count of entries that were processed successfully.

int64 success_count = 3;

Returns
Type Description
long

The successCount.

getUpdateTime()

public Timestamp getUpdateTime()

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public ImportMetadata.Builder mergeCreateTime(Timestamp value)

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
ImportMetadata.Builder

mergeFrom(ImportMetadata other)

public ImportMetadata.Builder mergeFrom(ImportMetadata other)
Parameter
Name Description
other ImportMetadata
Returns
Type Description
ImportMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ImportMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ImportMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ImportMetadata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ImportMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ImportMetadata.Builder
Overrides

mergeUpdateTime(Timestamp value)

public ImportMetadata.Builder mergeUpdateTime(Timestamp value)

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
ImportMetadata.Builder

setCreateTime(Timestamp value)

public ImportMetadata.Builder setCreateTime(Timestamp value)

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
ImportMetadata.Builder

setCreateTime(Timestamp.Builder builderForValue)

public ImportMetadata.Builder setCreateTime(Timestamp.Builder builderForValue)

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ImportMetadata.Builder

setFailureCount(long value)

public ImportMetadata.Builder setFailureCount(long value)

Count of entries that encountered errors while processing.

int64 failure_count = 4;

Parameter
Name Description
value long

The failureCount to set.

Returns
Type Description
ImportMetadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ImportMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ImportMetadata.Builder
Overrides

setNotificationPubsubTopic(String value)

public ImportMetadata.Builder setNotificationPubsubTopic(String value)

Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}.

string notification_pubsub_topic = 6;

Parameter
Name Description
value String

The notificationPubsubTopic to set.

Returns
Type Description
ImportMetadata.Builder

This builder for chaining.

setNotificationPubsubTopicBytes(ByteString value)

public ImportMetadata.Builder setNotificationPubsubTopicBytes(ByteString value)

Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}.

string notification_pubsub_topic = 6;

Parameter
Name Description
value ByteString

The bytes for notificationPubsubTopic to set.

Returns
Type Description
ImportMetadata.Builder

This builder for chaining.

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

public ImportMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ImportMetadata.Builder
Overrides

setRequestId(String value) (deprecated)

public ImportMetadata.Builder setRequestId(String value)

Deprecated. google.cloud.retail.v2.ImportMetadata.request_id is deprecated. See google/cloud/retail/v2/import_config.proto;l=336

Deprecated. This field is never set.

string request_id = 5 [deprecated = true];

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
ImportMetadata.Builder

This builder for chaining.

setRequestIdBytes(ByteString value) (deprecated)

public ImportMetadata.Builder setRequestIdBytes(ByteString value)

Deprecated. google.cloud.retail.v2.ImportMetadata.request_id is deprecated. See google/cloud/retail/v2/import_config.proto;l=336

Deprecated. This field is never set.

string request_id = 5 [deprecated = true];

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
ImportMetadata.Builder

This builder for chaining.

setSuccessCount(long value)

public ImportMetadata.Builder setSuccessCount(long value)

Count of entries that were processed successfully.

int64 success_count = 3;

Parameter
Name Description
value long

The successCount to set.

Returns
Type Description
ImportMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ImportMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ImportMetadata.Builder
Overrides

setUpdateTime(Timestamp value)

public ImportMetadata.Builder setUpdateTime(Timestamp value)

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
ImportMetadata.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public ImportMetadata.Builder setUpdateTime(Timestamp.Builder builderForValue)

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ImportMetadata.Builder