Class Metadata (0.24.0)

public final class Metadata extends GeneratedMessageV3 implements MetadataOrBuilder

Carries information about the pipeline execution that is returned in the long running operation's metadata field.

Protobuf type google.cloud.lifesciences.v2beta.Metadata

Implements

MetadataOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

EVENTS_FIELD_NUMBER

public static final int EVENTS_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

PIPELINE_FIELD_NUMBER

public static final int PIPELINE_FIELD_NUMBER
Field Value
TypeDescription
int

PUB_SUB_TOPIC_FIELD_NUMBER

public static final int PUB_SUB_TOPIC_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Metadata getDefaultInstance()
Returns
TypeDescription
Metadata

getDescriptor()

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

newBuilder()

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

newBuilder(Metadata prototype)

public static Metadata.Builder newBuilder(Metadata prototype)
Parameter
NameDescription
prototypeMetadata
Returns
TypeDescription
Metadata.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

The user-defined labels associated with this operation.

map<string, string> labels = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getCreateTime()

public Timestamp getCreateTime()

The time at which the operation was created by the API.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time at which the operation was created by the API.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Metadata getDefaultInstanceForType()
Returns
TypeDescription
Metadata

getEndTime()

public Timestamp getEndTime()

The time at which execution was completed and resources were cleaned up.

.google.protobuf.Timestamp end_time = 6;

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

The time at which execution was completed and resources were cleaned up.

.google.protobuf.Timestamp end_time = 6;

Returns
TypeDescription
TimestampOrBuilder

getEvents(int index)

public Event getEvents(int index)

The list of events that have happened so far during the execution of this operation.

repeated .google.cloud.lifesciences.v2beta.Event events = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Event

getEventsCount()

public int getEventsCount()

The list of events that have happened so far during the execution of this operation.

repeated .google.cloud.lifesciences.v2beta.Event events = 3;

Returns
TypeDescription
int

getEventsList()

public List<Event> getEventsList()

The list of events that have happened so far during the execution of this operation.

repeated .google.cloud.lifesciences.v2beta.Event events = 3;

Returns
TypeDescription
List<Event>

getEventsOrBuilder(int index)

public EventOrBuilder getEventsOrBuilder(int index)

The list of events that have happened so far during the execution of this operation.

repeated .google.cloud.lifesciences.v2beta.Event events = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
EventOrBuilder

getEventsOrBuilderList()

public List<? extends EventOrBuilder> getEventsOrBuilderList()

The list of events that have happened so far during the execution of this operation.

repeated .google.cloud.lifesciences.v2beta.Event events = 3;

Returns
TypeDescription
List<? extends com.google.cloud.lifesciences.v2beta.EventOrBuilder>

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

The user-defined labels associated with this operation.

map<string, string> labels = 2;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

The user-defined labels associated with this operation.

map<string, string> labels = 2;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

The user-defined labels associated with this operation.

map<string, string> labels = 2;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

The user-defined labels associated with this operation.

map<string, string> labels = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getParserForType()

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

getPipeline()

public Pipeline getPipeline()

The pipeline this operation represents.

.google.cloud.lifesciences.v2beta.Pipeline pipeline = 1;

Returns
TypeDescription
Pipeline

The pipeline.

getPipelineOrBuilder()

public PipelineOrBuilder getPipelineOrBuilder()

The pipeline this operation represents.

.google.cloud.lifesciences.v2beta.Pipeline pipeline = 1;

Returns
TypeDescription
PipelineOrBuilder

getPubSubTopic()

public String getPubSubTopic()

The name of the Cloud Pub/Sub topic where notifications of operation status changes are sent.

string pub_sub_topic = 7;

Returns
TypeDescription
String

The pubSubTopic.

getPubSubTopicBytes()

public ByteString getPubSubTopicBytes()

The name of the Cloud Pub/Sub topic where notifications of operation status changes are sent.

string pub_sub_topic = 7;

Returns
TypeDescription
ByteString

The bytes for pubSubTopic.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStartTime()

public Timestamp getStartTime()

The first time at which resources were allocated to execute the pipeline.

.google.protobuf.Timestamp start_time = 5;

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The first time at which resources were allocated to execute the pipeline.

.google.protobuf.Timestamp start_time = 5;

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

The time at which the operation was created by the API.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasEndTime()

public boolean hasEndTime()

The time at which execution was completed and resources were cleaned up.

.google.protobuf.Timestamp end_time = 6;

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasPipeline()

public boolean hasPipeline()

The pipeline this operation represents.

.google.cloud.lifesciences.v2beta.Pipeline pipeline = 1;

Returns
TypeDescription
boolean

Whether the pipeline field is set.

hasStartTime()

public boolean hasStartTime()

The first time at which resources were allocated to execute the pipeline.

.google.protobuf.Timestamp start_time = 5;

Returns
TypeDescription
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Metadata.Builder newBuilderForType()
Returns
TypeDescription
Metadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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