org.tensorflow.framework

Class TraceEvent.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>

org.tensorflow.framework.TraceEvent.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, TraceEventOrBuilder

Enclosing class:

TraceEvent

public static final class TraceEvent.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>
implements TraceEventOrBuilder

Protobuf type tensorflow.profiler.TraceEvent

Method Summary

Modifier and Type	Method and Description
TraceEvent.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
TraceEvent	build()
TraceEvent	buildPartial()
TraceEvent.Builder	clear()
TraceEvent.Builder	clearArgs()
TraceEvent.Builder	clearDeviceId() The id of the device that this event occurred on.
TraceEvent.Builder	clearDurationPs() The duration of the event in picoseconds if applicable.
TraceEvent.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
TraceEvent.Builder	clearName() The name of this trace event.
TraceEvent.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
TraceEvent.Builder	clearResourceId() The id of the resource that this event occurred on.
TraceEvent.Builder	clearTimestampPs() The timestamp that this event occurred at (in picos since tracing started).
TraceEvent.Builder	clone()
boolean	containsArgs(String key) Extra arguments that will be displayed in trace view.
Map<String,String>	getArgs() Deprecated.
int	getArgsCount() Extra arguments that will be displayed in trace view.
Map<String,String>	getArgsMap() Extra arguments that will be displayed in trace view.
String	getArgsOrDefault(String key, String defaultValue) Extra arguments that will be displayed in trace view.
String	getArgsOrThrow(String key) Extra arguments that will be displayed in trace view.
TraceEvent	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
int	getDeviceId() The id of the device that this event occurred on.
long	getDurationPs() The duration of the event in picoseconds if applicable.
Map<String,String>	getMutableArgs() Deprecated.
String	getName() The name of this trace event.
com.google.protobuf.ByteString	getNameBytes() The name of this trace event.
int	getResourceId() The id of the resource that this event occurred on.
long	getTimestampPs() The timestamp that this event occurred at (in picos since tracing started).
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
protected com.google.protobuf.MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
TraceEvent.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
TraceEvent.Builder	mergeFrom(com.google.protobuf.Message other)
TraceEvent.Builder	mergeFrom(TraceEvent other)
TraceEvent.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
TraceEvent.Builder	putAllArgs(Map<String,String> values) Extra arguments that will be displayed in trace view.
TraceEvent.Builder	putArgs(String key, String value) Extra arguments that will be displayed in trace view.
TraceEvent.Builder	removeArgs(String key) Extra arguments that will be displayed in trace view.
TraceEvent.Builder	setDeviceId(int value) The id of the device that this event occurred on.
TraceEvent.Builder	setDurationPs(long value) The duration of the event in picoseconds if applicable.
TraceEvent.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
TraceEvent.Builder	setName(String value) The name of this trace event.
TraceEvent.Builder	setNameBytes(com.google.protobuf.ByteString value) The name of this trace event.
TraceEvent.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
TraceEvent.Builder	setResourceId(int value) The id of the resource that this event occurred on.
TraceEvent.Builder	setTimestampPs(long value) The timestamp that this event occurred at (in picos since tracing started).
TraceEvent.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>

internalGetMutableMapField

protected com.google.protobuf.MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>

clear

public TraceEvent.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>

getDefaultInstanceForType

public TraceEvent getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public TraceEvent build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public TraceEvent buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public TraceEvent.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>

setField

public TraceEvent.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                   Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>

clearField

public TraceEvent.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>

clearOneof

public TraceEvent.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>

setRepeatedField

public TraceEvent.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           int index,
                                           Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>

addRepeatedField

public TraceEvent.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>

mergeFrom

public TraceEvent.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TraceEvent.Builder>

mergeFrom

public TraceEvent.Builder mergeFrom(TraceEvent other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>

mergeFrom

public TraceEvent.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TraceEvent.Builder>

Throws:

IOException

getDeviceId

public int getDeviceId()

 The id of the device that this event occurred on. The full dataset should
 have this device present in the Trace object.
 

uint32 device_id = 1;

Specified by:

getDeviceId in interface TraceEventOrBuilder

setDeviceId

public TraceEvent.Builder setDeviceId(int value)

 The id of the device that this event occurred on. The full dataset should
 have this device present in the Trace object.
 

uint32 device_id = 1;

clearDeviceId

public TraceEvent.Builder clearDeviceId()

 The id of the device that this event occurred on. The full dataset should
 have this device present in the Trace object.
 

uint32 device_id = 1;

getResourceId

public int getResourceId()

 The id of the resource that this event occurred on. The full dataset should
 have this resource present in the Device object of the Trace object. A
 resource_id is unique on a specific device, but not necessarily within the
 trace.
 

uint32 resource_id = 2;

Specified by:

getResourceId in interface TraceEventOrBuilder

setResourceId

public TraceEvent.Builder setResourceId(int value)

 The id of the resource that this event occurred on. The full dataset should
 have this resource present in the Device object of the Trace object. A
 resource_id is unique on a specific device, but not necessarily within the
 trace.
 

uint32 resource_id = 2;

clearResourceId

public TraceEvent.Builder clearResourceId()

 The id of the resource that this event occurred on. The full dataset should
 have this resource present in the Device object of the Trace object. A
 resource_id is unique on a specific device, but not necessarily within the
 trace.
 

uint32 resource_id = 2;

getName

public String getName()

 The name of this trace event.
 

string name = 3;

Specified by:

getName in interface TraceEventOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The name of this trace event.
 

string name = 3;

Specified by:

getNameBytes in interface TraceEventOrBuilder

setName

public TraceEvent.Builder setName(String value)

 The name of this trace event.
 

string name = 3;

clearName

public TraceEvent.Builder clearName()

 The name of this trace event.
 

string name = 3;

setNameBytes

public TraceEvent.Builder setNameBytes(com.google.protobuf.ByteString value)

 The name of this trace event.
 

string name = 3;

getTimestampPs

public long getTimestampPs()

 The timestamp that this event occurred at (in picos since tracing started).
 

uint64 timestamp_ps = 9;

Specified by:

getTimestampPs in interface TraceEventOrBuilder

setTimestampPs

public TraceEvent.Builder setTimestampPs(long value)

 The timestamp that this event occurred at (in picos since tracing started).
 

uint64 timestamp_ps = 9;

clearTimestampPs

public TraceEvent.Builder clearTimestampPs()

 The timestamp that this event occurred at (in picos since tracing started).
 

uint64 timestamp_ps = 9;

getDurationPs

public long getDurationPs()

 The duration of the event in picoseconds if applicable.
 Events without duration are called instant events.
 

uint64 duration_ps = 10;

Specified by:

getDurationPs in interface TraceEventOrBuilder

setDurationPs

public TraceEvent.Builder setDurationPs(long value)

 The duration of the event in picoseconds if applicable.
 Events without duration are called instant events.
 

uint64 duration_ps = 10;

clearDurationPs

public TraceEvent.Builder clearDurationPs()

 The duration of the event in picoseconds if applicable.
 Events without duration are called instant events.
 

uint64 duration_ps = 10;

getArgsCount

public int getArgsCount()

Description copied from interface: TraceEventOrBuilder

 Extra arguments that will be displayed in trace view.
 

map<string, string> args = 11;

Specified by:

getArgsCount in interface TraceEventOrBuilder

containsArgs

public boolean containsArgs(String key)

 Extra arguments that will be displayed in trace view.
 

map<string, string> args = 11;

Specified by:

containsArgs in interface TraceEventOrBuilder

getArgs

@Deprecated
public Map<String,String> getArgs()

Deprecated.

Use getArgsMap() instead.

Specified by:

getArgs in interface TraceEventOrBuilder

getArgsMap

public Map<String,String> getArgsMap()

 Extra arguments that will be displayed in trace view.
 

map<string, string> args = 11;

Specified by:

getArgsMap in interface TraceEventOrBuilder

getArgsOrDefault

public String getArgsOrDefault(String key,
                               String defaultValue)

 Extra arguments that will be displayed in trace view.
 

map<string, string> args = 11;

Specified by:

getArgsOrDefault in interface TraceEventOrBuilder

getArgsOrThrow

public String getArgsOrThrow(String key)

 Extra arguments that will be displayed in trace view.
 

map<string, string> args = 11;

Specified by:

getArgsOrThrow in interface TraceEventOrBuilder

clearArgs

public TraceEvent.Builder clearArgs()

removeArgs

public TraceEvent.Builder removeArgs(String key)

 Extra arguments that will be displayed in trace view.
 

map<string, string> args = 11;

getMutableArgs

@Deprecated
public Map<String,String> getMutableArgs()

Deprecated.

Use alternate mutation accessors instead.

putArgs

public TraceEvent.Builder putArgs(String key,
                                  String value)

 Extra arguments that will be displayed in trace view.
 

map<string, string> args = 11;

putAllArgs

public TraceEvent.Builder putAllArgs(Map<String,String> values)

 Extra arguments that will be displayed in trace view.
 

map<string, string> args = 11;

setUnknownFields

public final TraceEvent.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>

mergeUnknownFields

public final TraceEvent.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TraceEvent.Builder>