public final class ApiDef extends com.google.protobuf.GeneratedMessageV3 implements ApiDefOrBuilder
Used to specify and override the default API & behavior in the generated code for client languages, from what you would get from the OpDef alone. There will be a set of ApiDefs that are common to all client languages, and another set per client language. The per-client-language ApiDefs will inherit values from the common ApiDefs which it can either replace or modify. We separate the API definition from the OpDef so we can evolve the API while remaining backwards compatible when interpretting old graphs. Overrides go in an "api_def.pbtxt" file with a text-format ApiDefs message. WARNING: Be *very* careful changing the API for any existing op -- you can change the semantics of existing code. These changes may need to wait until a major release of TensorFlow to avoid breaking our compatibility promises.Protobuf type
tensorflow.ApiDef
Modifier and Type | Class and Description |
---|---|
static class |
ApiDef.Arg
Protobuf type
tensorflow.ApiDef.Arg |
static interface |
ApiDef.ArgOrBuilder |
static class |
ApiDef.Attr
Description of the graph-construction-time configuration of this
Op.
|
static interface |
ApiDef.AttrOrBuilder |
static class |
ApiDef.Builder
Used to specify and override the default API & behavior in the
generated code for client languages, from what you would get from
the OpDef alone.
|
static class |
ApiDef.Endpoint
If you specify any endpoint, this will replace all of the
inherited endpoints.
|
static interface |
ApiDef.EndpointOrBuilder |
static class |
ApiDef.Visibility
Protobuf enum
tensorflow.ApiDef.Visibility |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
Modifier and Type | Field and Description |
---|---|
static int |
ARG_ORDER_FIELD_NUMBER |
static int |
ATTR_FIELD_NUMBER |
static int |
DEPRECATION_MESSAGE_FIELD_NUMBER |
static int |
DEPRECATION_VERSION_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
DESCRIPTION_PREFIX_FIELD_NUMBER |
static int |
DESCRIPTION_SUFFIX_FIELD_NUMBER |
static int |
ENDPOINT_FIELD_NUMBER |
static int |
GRAPH_OP_NAME_FIELD_NUMBER |
static int |
IN_ARG_FIELD_NUMBER |
static int |
OUT_ARG_FIELD_NUMBER |
static int |
SUMMARY_FIELD_NUMBER |
static int |
VISIBILITY_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getArgOrder(int index)
List of original in_arg names to specify new argument order.
|
com.google.protobuf.ByteString |
getArgOrderBytes(int index)
List of original in_arg names to specify new argument order.
|
int |
getArgOrderCount()
List of original in_arg names to specify new argument order.
|
com.google.protobuf.ProtocolStringList |
getArgOrderList()
List of original in_arg names to specify new argument order.
|
ApiDef.Attr |
getAttr(int index)
repeated .tensorflow.ApiDef.Attr attr = 6; |
int |
getAttrCount()
repeated .tensorflow.ApiDef.Attr attr = 6; |
List<ApiDef.Attr> |
getAttrList()
repeated .tensorflow.ApiDef.Attr attr = 6; |
ApiDef.AttrOrBuilder |
getAttrOrBuilder(int index)
repeated .tensorflow.ApiDef.Attr attr = 6; |
List<? extends ApiDef.AttrOrBuilder> |
getAttrOrBuilderList()
repeated .tensorflow.ApiDef.Attr attr = 6; |
static ApiDef |
getDefaultInstance() |
ApiDef |
getDefaultInstanceForType() |
String |
getDeprecationMessage()
If this op is deprecated, set deprecation message to the message
that should be logged when this op is used.
|
com.google.protobuf.ByteString |
getDeprecationMessageBytes()
If this op is deprecated, set deprecation message to the message
that should be logged when this op is used.
|
int |
getDeprecationVersion()
Major version when the op will be deleted.
|
String |
getDescription()
Additional, longer human-readable description of what the Op does.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Additional, longer human-readable description of what the Op does.
|
String |
getDescriptionPrefix()
Modify an existing/inherited description by adding text to the beginning
or end.
|
com.google.protobuf.ByteString |
getDescriptionPrefixBytes()
Modify an existing/inherited description by adding text to the beginning
or end.
|
String |
getDescriptionSuffix()
string description_suffix = 10; |
com.google.protobuf.ByteString |
getDescriptionSuffixBytes()
string description_suffix = 10; |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
ApiDef.Endpoint |
getEndpoint(int index)
repeated .tensorflow.ApiDef.Endpoint endpoint = 3; |
int |
getEndpointCount()
repeated .tensorflow.ApiDef.Endpoint endpoint = 3; |
List<ApiDef.Endpoint> |
getEndpointList()
repeated .tensorflow.ApiDef.Endpoint endpoint = 3; |
ApiDef.EndpointOrBuilder |
getEndpointOrBuilder(int index)
repeated .tensorflow.ApiDef.Endpoint endpoint = 3; |
List<? extends ApiDef.EndpointOrBuilder> |
getEndpointOrBuilderList()
repeated .tensorflow.ApiDef.Endpoint endpoint = 3; |
String |
getGraphOpName()
Name of the op (in the OpDef) to specify the API for.
|
com.google.protobuf.ByteString |
getGraphOpNameBytes()
Name of the op (in the OpDef) to specify the API for.
|
ApiDef.Arg |
getInArg(int index)
repeated .tensorflow.ApiDef.Arg in_arg = 4; |
int |
getInArgCount()
repeated .tensorflow.ApiDef.Arg in_arg = 4; |
List<ApiDef.Arg> |
getInArgList()
repeated .tensorflow.ApiDef.Arg in_arg = 4; |
ApiDef.ArgOrBuilder |
getInArgOrBuilder(int index)
repeated .tensorflow.ApiDef.Arg in_arg = 4; |
List<? extends ApiDef.ArgOrBuilder> |
getInArgOrBuilderList()
repeated .tensorflow.ApiDef.Arg in_arg = 4; |
ApiDef.Arg |
getOutArg(int index)
repeated .tensorflow.ApiDef.Arg out_arg = 5; |
int |
getOutArgCount()
repeated .tensorflow.ApiDef.Arg out_arg = 5; |
List<ApiDef.Arg> |
getOutArgList()
repeated .tensorflow.ApiDef.Arg out_arg = 5; |
ApiDef.ArgOrBuilder |
getOutArgOrBuilder(int index)
repeated .tensorflow.ApiDef.Arg out_arg = 5; |
List<? extends ApiDef.ArgOrBuilder> |
getOutArgOrBuilderList()
repeated .tensorflow.ApiDef.Arg out_arg = 5; |
com.google.protobuf.Parser<ApiDef> |
getParserForType() |
int |
getSerializedSize() |
String |
getSummary()
One-line human-readable description of what the Op does.
|
com.google.protobuf.ByteString |
getSummaryBytes()
One-line human-readable description of what the Op does.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
ApiDef.Visibility |
getVisibility()
.tensorflow.ApiDef.Visibility visibility = 2; |
int |
getVisibilityValue()
.tensorflow.ApiDef.Visibility visibility = 2; |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ApiDef.Builder |
newBuilder() |
static ApiDef.Builder |
newBuilder(ApiDef prototype) |
ApiDef.Builder |
newBuilderForType() |
protected ApiDef.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static ApiDef |
parseDelimitedFrom(InputStream input) |
static ApiDef |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ApiDef |
parseFrom(byte[] data) |
static ApiDef |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ApiDef |
parseFrom(ByteBuffer data) |
static ApiDef |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ApiDef |
parseFrom(com.google.protobuf.ByteString data) |
static ApiDef |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ApiDef |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ApiDef |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ApiDef |
parseFrom(InputStream input) |
static ApiDef |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ApiDef> |
parser() |
ApiDef.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int GRAPH_OP_NAME_FIELD_NUMBER
public static final int DEPRECATION_MESSAGE_FIELD_NUMBER
public static final int DEPRECATION_VERSION_FIELD_NUMBER
public static final int VISIBILITY_FIELD_NUMBER
public static final int ENDPOINT_FIELD_NUMBER
public static final int IN_ARG_FIELD_NUMBER
public static final int OUT_ARG_FIELD_NUMBER
public static final int ARG_ORDER_FIELD_NUMBER
public static final int ATTR_FIELD_NUMBER
public static final int SUMMARY_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_PREFIX_FIELD_NUMBER
public static final int DESCRIPTION_SUFFIX_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public String getGraphOpName()
Name of the op (in the OpDef) to specify the API for.
string graph_op_name = 1;
getGraphOpName
in interface ApiDefOrBuilder
public com.google.protobuf.ByteString getGraphOpNameBytes()
Name of the op (in the OpDef) to specify the API for.
string graph_op_name = 1;
getGraphOpNameBytes
in interface ApiDefOrBuilder
public String getDeprecationMessage()
If this op is deprecated, set deprecation message to the message that should be logged when this op is used. The message should indicate alternative op to use, if any.
string deprecation_message = 12;
getDeprecationMessage
in interface ApiDefOrBuilder
public com.google.protobuf.ByteString getDeprecationMessageBytes()
If this op is deprecated, set deprecation message to the message that should be logged when this op is used. The message should indicate alternative op to use, if any.
string deprecation_message = 12;
getDeprecationMessageBytes
in interface ApiDefOrBuilder
public int getDeprecationVersion()
Major version when the op will be deleted. For e.g. set this value to 2 if op API should be removed in TensorFlow 2.0 and deprecated in versions before that.
int32 deprecation_version = 13;
getDeprecationVersion
in interface ApiDefOrBuilder
public int getVisibilityValue()
.tensorflow.ApiDef.Visibility visibility = 2;
getVisibilityValue
in interface ApiDefOrBuilder
public ApiDef.Visibility getVisibility()
.tensorflow.ApiDef.Visibility visibility = 2;
getVisibility
in interface ApiDefOrBuilder
public List<ApiDef.Endpoint> getEndpointList()
repeated .tensorflow.ApiDef.Endpoint endpoint = 3;
getEndpointList
in interface ApiDefOrBuilder
public List<? extends ApiDef.EndpointOrBuilder> getEndpointOrBuilderList()
repeated .tensorflow.ApiDef.Endpoint endpoint = 3;
getEndpointOrBuilderList
in interface ApiDefOrBuilder
public int getEndpointCount()
repeated .tensorflow.ApiDef.Endpoint endpoint = 3;
getEndpointCount
in interface ApiDefOrBuilder
public ApiDef.Endpoint getEndpoint(int index)
repeated .tensorflow.ApiDef.Endpoint endpoint = 3;
getEndpoint
in interface ApiDefOrBuilder
public ApiDef.EndpointOrBuilder getEndpointOrBuilder(int index)
repeated .tensorflow.ApiDef.Endpoint endpoint = 3;
getEndpointOrBuilder
in interface ApiDefOrBuilder
public List<ApiDef.Arg> getInArgList()
repeated .tensorflow.ApiDef.Arg in_arg = 4;
getInArgList
in interface ApiDefOrBuilder
public List<? extends ApiDef.ArgOrBuilder> getInArgOrBuilderList()
repeated .tensorflow.ApiDef.Arg in_arg = 4;
getInArgOrBuilderList
in interface ApiDefOrBuilder
public int getInArgCount()
repeated .tensorflow.ApiDef.Arg in_arg = 4;
getInArgCount
in interface ApiDefOrBuilder
public ApiDef.Arg getInArg(int index)
repeated .tensorflow.ApiDef.Arg in_arg = 4;
getInArg
in interface ApiDefOrBuilder
public ApiDef.ArgOrBuilder getInArgOrBuilder(int index)
repeated .tensorflow.ApiDef.Arg in_arg = 4;
getInArgOrBuilder
in interface ApiDefOrBuilder
public List<ApiDef.Arg> getOutArgList()
repeated .tensorflow.ApiDef.Arg out_arg = 5;
getOutArgList
in interface ApiDefOrBuilder
public List<? extends ApiDef.ArgOrBuilder> getOutArgOrBuilderList()
repeated .tensorflow.ApiDef.Arg out_arg = 5;
getOutArgOrBuilderList
in interface ApiDefOrBuilder
public int getOutArgCount()
repeated .tensorflow.ApiDef.Arg out_arg = 5;
getOutArgCount
in interface ApiDefOrBuilder
public ApiDef.Arg getOutArg(int index)
repeated .tensorflow.ApiDef.Arg out_arg = 5;
getOutArg
in interface ApiDefOrBuilder
public ApiDef.ArgOrBuilder getOutArgOrBuilder(int index)
repeated .tensorflow.ApiDef.Arg out_arg = 5;
getOutArgOrBuilder
in interface ApiDefOrBuilder
public com.google.protobuf.ProtocolStringList getArgOrderList()
List of original in_arg names to specify new argument order. Length of arg_order should be either empty to keep current order or match size of in_arg.
repeated string arg_order = 11;
getArgOrderList
in interface ApiDefOrBuilder
public int getArgOrderCount()
List of original in_arg names to specify new argument order. Length of arg_order should be either empty to keep current order or match size of in_arg.
repeated string arg_order = 11;
getArgOrderCount
in interface ApiDefOrBuilder
public String getArgOrder(int index)
List of original in_arg names to specify new argument order. Length of arg_order should be either empty to keep current order or match size of in_arg.
repeated string arg_order = 11;
getArgOrder
in interface ApiDefOrBuilder
public com.google.protobuf.ByteString getArgOrderBytes(int index)
List of original in_arg names to specify new argument order. Length of arg_order should be either empty to keep current order or match size of in_arg.
repeated string arg_order = 11;
getArgOrderBytes
in interface ApiDefOrBuilder
public List<ApiDef.Attr> getAttrList()
repeated .tensorflow.ApiDef.Attr attr = 6;
getAttrList
in interface ApiDefOrBuilder
public List<? extends ApiDef.AttrOrBuilder> getAttrOrBuilderList()
repeated .tensorflow.ApiDef.Attr attr = 6;
getAttrOrBuilderList
in interface ApiDefOrBuilder
public int getAttrCount()
repeated .tensorflow.ApiDef.Attr attr = 6;
getAttrCount
in interface ApiDefOrBuilder
public ApiDef.Attr getAttr(int index)
repeated .tensorflow.ApiDef.Attr attr = 6;
getAttr
in interface ApiDefOrBuilder
public ApiDef.AttrOrBuilder getAttrOrBuilder(int index)
repeated .tensorflow.ApiDef.Attr attr = 6;
getAttrOrBuilder
in interface ApiDefOrBuilder
public String getSummary()
One-line human-readable description of what the Op does.
string summary = 7;
getSummary
in interface ApiDefOrBuilder
public com.google.protobuf.ByteString getSummaryBytes()
One-line human-readable description of what the Op does.
string summary = 7;
getSummaryBytes
in interface ApiDefOrBuilder
public String getDescription()
Additional, longer human-readable description of what the Op does.
string description = 8;
getDescription
in interface ApiDefOrBuilder
public com.google.protobuf.ByteString getDescriptionBytes()
Additional, longer human-readable description of what the Op does.
string description = 8;
getDescriptionBytes
in interface ApiDefOrBuilder
public String getDescriptionPrefix()
Modify an existing/inherited description by adding text to the beginning or end.
string description_prefix = 9;
getDescriptionPrefix
in interface ApiDefOrBuilder
public com.google.protobuf.ByteString getDescriptionPrefixBytes()
Modify an existing/inherited description by adding text to the beginning or end.
string description_prefix = 9;
getDescriptionPrefixBytes
in interface ApiDefOrBuilder
public String getDescriptionSuffix()
string description_suffix = 10;
getDescriptionSuffix
in interface ApiDefOrBuilder
public com.google.protobuf.ByteString getDescriptionSuffixBytes()
string description_suffix = 10;
getDescriptionSuffixBytes
in interface ApiDefOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static ApiDef parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ApiDef parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ApiDef parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ApiDef parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ApiDef parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ApiDef parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static ApiDef parseFrom(InputStream input) throws IOException
IOException
public static ApiDef parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static ApiDef parseDelimitedFrom(InputStream input) throws IOException
IOException
public static ApiDef parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static ApiDef parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static ApiDef parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public ApiDef.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static ApiDef.Builder newBuilder()
public static ApiDef.Builder newBuilder(ApiDef prototype)
public ApiDef.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected ApiDef.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static ApiDef getDefaultInstance()
public static com.google.protobuf.Parser<ApiDef> parser()
public com.google.protobuf.Parser<ApiDef> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public ApiDef getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2015–2019. All rights reserved.