Class ImportMetadata (2.24.0)

public final class ImportMetadata extends GeneratedMessageV3 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.v2beta.ImportMetadata

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

FAILURE_COUNT_FIELD_NUMBER

public static final int FAILURE_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER

public static final int NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
TypeDescription
int

SUCCESS_COUNT_FIELD_NUMBER

public static final int SUCCESS_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ImportMetadata getDefaultInstance()
Returns
TypeDescription
ImportMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(ImportMetadata prototype)

public static ImportMetadata.Builder newBuilder(ImportMetadata prototype)
Parameter
NameDescription
prototypeImportMetadata
Returns
TypeDescription
ImportMetadata.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCreateTime()

public Timestamp getCreateTime()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public ImportMetadata getDefaultInstanceForType()
Returns
TypeDescription
ImportMetadata

getFailureCount()

public long getFailureCount()

Count of entries that encountered errors while processing.

int64 failure_count = 4;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for notificationPubsubTopic.

getParserForType()

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

getRequestId() (deprecated)

public String getRequestId()

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

Deprecated. This field is never set.

string request_id = 5 [deprecated = true];

Returns
TypeDescription
String

The requestId.

getRequestIdBytes() (deprecated)

public ByteString getRequestIdBytes()

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

Deprecated. This field is never set.

string request_id = 5 [deprecated = true];

Returns
TypeDescription
ByteString

The bytes for requestId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSuccessCount()

public long getSuccessCount()

Count of entries that were processed successfully.

int64 success_count = 3;

Returns
TypeDescription
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
TypeDescription
Timestamp

The updateTime.

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
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
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
TypeDescription
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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