com.databricks.api.proto.databricks

Class Databricks.DocumentationMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.databricks.api.proto.databricks.Databricks.DocumentationMetadata

All Implemented Interfaces:

Databricks.DocumentationMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Databricks

public static final class Databricks.DocumentationMetadata
extends com.google.protobuf.GeneratedMessageV3
implements Databricks.DocumentationMetadataOrBuilder

 A block of documentation that is added to the AST after parsing the original protocol buffer.
 

Protobuf type DocumentationMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Databricks.DocumentationMetadata.Builder A block of documentation that is added to the AST after parsing the original protocol buffer.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOCSTRING_FIELD_NUMBER
static int	LEAD_DOC_FIELD_NUMBER
static int	ORIGINAL_PROTO_PATH_FIELD_NUMBER
static com.google.protobuf.Parser<Databricks.DocumentationMetadata>	PARSER Deprecated.
static int	POSITION_FIELD_NUMBER
static int	VISIBILITY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Databricks.DocumentationMetadata	getDefaultInstance()
Databricks.DocumentationMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDocstring() The string of documentation attached to this particular item.
com.google.protobuf.ByteString	getDocstringBytes() The string of documentation attached to this particular item.
String	getLeadDoc() The string of documentation that is *before* this item.
com.google.protobuf.ByteString	getLeadDocBytes() The string of documentation that is *before* this item.
String	getOriginalProtoPath(int index) The original proto path in the internal representation.
com.google.protobuf.ByteString	getOriginalProtoPathBytes(int index) The original proto path in the internal representation.
int	getOriginalProtoPathCount() The original proto path in the internal representation.
com.google.protobuf.ProtocolStringList	getOriginalProtoPathList() The original proto path in the internal representation.
com.google.protobuf.Parser<Databricks.DocumentationMetadata>	getParserForType()
int	getPosition() The location (line number) of the start of the documentation.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
Databricks.Visibility	getVisibility() The visibility level when the docstring was generated.
boolean	hasDocstring() The string of documentation attached to this particular item.
int	hashCode()
boolean	hasLeadDoc() The string of documentation that is *before* this item.
boolean	hasPosition() The location (line number) of the start of the documentation.
boolean	hasVisibility() The visibility level when the docstring was generated.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Databricks.DocumentationMetadata.Builder	newBuilder()
static Databricks.DocumentationMetadata.Builder	newBuilder(Databricks.DocumentationMetadata prototype)
Databricks.DocumentationMetadata.Builder	newBuilderForType()
protected Databricks.DocumentationMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Databricks.DocumentationMetadata	parseDelimitedFrom(InputStream input)
static Databricks.DocumentationMetadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Databricks.DocumentationMetadata	parseFrom(byte[] data)
static Databricks.DocumentationMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Databricks.DocumentationMetadata	parseFrom(ByteBuffer data)
static Databricks.DocumentationMetadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Databricks.DocumentationMetadata	parseFrom(com.google.protobuf.ByteString data)
static Databricks.DocumentationMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Databricks.DocumentationMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static Databricks.DocumentationMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Databricks.DocumentationMetadata	parseFrom(InputStream input)
static Databricks.DocumentationMetadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Databricks.DocumentationMetadata>	parser()
Databricks.DocumentationMetadata.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

DOCSTRING_FIELD_NUMBER

public static final int DOCSTRING_FIELD_NUMBER

See Also:

Constant Field Values

LEAD_DOC_FIELD_NUMBER

public static final int LEAD_DOC_FIELD_NUMBER

See Also:

Constant Field Values

VISIBILITY_FIELD_NUMBER

public static final int VISIBILITY_FIELD_NUMBER

See Also:

Constant Field Values

ORIGINAL_PROTO_PATH_FIELD_NUMBER

public static final int ORIGINAL_PROTO_PATH_FIELD_NUMBER

See Also:

Constant Field Values

POSITION_FIELD_NUMBER

public static final int POSITION_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<Databricks.DocumentationMetadata> PARSER

Deprecated.

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasDocstring

public boolean hasDocstring()

 The string of documentation attached to this particular item.
 

optional string docstring = 1;

Specified by:

hasDocstring in interface Databricks.DocumentationMetadataOrBuilder

getDocstring

public String getDocstring()

 The string of documentation attached to this particular item.
 

optional string docstring = 1;

Specified by:

getDocstring in interface Databricks.DocumentationMetadataOrBuilder

getDocstringBytes

public com.google.protobuf.ByteString getDocstringBytes()

 The string of documentation attached to this particular item.
 

optional string docstring = 1;

Specified by:

getDocstringBytes in interface Databricks.DocumentationMetadataOrBuilder

hasLeadDoc

public boolean hasLeadDoc()

 The string of documentation that is *before* this item. This only makes sense for top-level
 items such as (top-level) messages, (top-level) enumerations, or services. In all other
 cases, this string is empty.
 

optional string lead_doc = 2;

Specified by:

hasLeadDoc in interface Databricks.DocumentationMetadataOrBuilder

getLeadDoc

public String getLeadDoc()

 The string of documentation that is *before* this item. This only makes sense for top-level
 items such as (top-level) messages, (top-level) enumerations, or services. In all other
 cases, this string is empty.
 

optional string lead_doc = 2;

Specified by:

getLeadDoc in interface Databricks.DocumentationMetadataOrBuilder

getLeadDocBytes

public com.google.protobuf.ByteString getLeadDocBytes()

 The string of documentation that is *before* this item. This only makes sense for top-level
 items such as (top-level) messages, (top-level) enumerations, or services. In all other
 cases, this string is empty.
 

optional string lead_doc = 2;

Specified by:

getLeadDocBytes in interface Databricks.DocumentationMetadataOrBuilder

hasVisibility

public boolean hasVisibility()

 The visibility level when the docstring was generated.
 The documentation extractor builds multiple versions of the documentation, one for each
 visibility level. The documentation is then generated for each visibility level.
 

optional .Visibility visibility = 3;

Specified by:

hasVisibility in interface Databricks.DocumentationMetadataOrBuilder

getVisibility

public Databricks.Visibility getVisibility()

 The visibility level when the docstring was generated.
 The documentation extractor builds multiple versions of the documentation, one for each
 visibility level. The documentation is then generated for each visibility level.
 

optional .Visibility visibility = 3;

Specified by:

getVisibility in interface Databricks.DocumentationMetadataOrBuilder

getOriginalProtoPathList

public com.google.protobuf.ProtocolStringList getOriginalProtoPathList()

 The original proto path in the internal representation. This is useful when performing field
 flattening to figure out what the original field was.
 One example is ["jobs","Run","original_attempt_run_id"] for jobs.
 This path is unique.
 

repeated string original_proto_path = 4;

Specified by:

getOriginalProtoPathList in interface Databricks.DocumentationMetadataOrBuilder

getOriginalProtoPathCount

public int getOriginalProtoPathCount()

 The original proto path in the internal representation. This is useful when performing field
 flattening to figure out what the original field was.
 One example is ["jobs","Run","original_attempt_run_id"] for jobs.
 This path is unique.
 

repeated string original_proto_path = 4;

Specified by:

getOriginalProtoPathCount in interface Databricks.DocumentationMetadataOrBuilder

getOriginalProtoPath

public String getOriginalProtoPath(int index)

 The original proto path in the internal representation. This is useful when performing field
 flattening to figure out what the original field was.
 One example is ["jobs","Run","original_attempt_run_id"] for jobs.
 This path is unique.
 

repeated string original_proto_path = 4;

Specified by:

getOriginalProtoPath in interface Databricks.DocumentationMetadataOrBuilder

getOriginalProtoPathBytes

public com.google.protobuf.ByteString getOriginalProtoPathBytes(int index)

 The original proto path in the internal representation. This is useful when performing field
 flattening to figure out what the original field was.
 One example is ["jobs","Run","original_attempt_run_id"] for jobs.
 This path is unique.
 

repeated string original_proto_path = 4;

Specified by:

getOriginalProtoPathBytes in interface Databricks.DocumentationMetadataOrBuilder

hasPosition

public boolean hasPosition()

 The location (line number) of the start of the documentation. This is required to keep the
 pieces of documentation sorted.
 

optional int32 position = 5;

Specified by:

hasPosition in interface Databricks.DocumentationMetadataOrBuilder

getPosition

public int getPosition()

 The location (line number) of the start of the documentation. This is required to keep the
 pieces of documentation sorted.
 

optional int32 position = 5;

Specified by:

getPosition in interface Databricks.DocumentationMetadataOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Databricks.DocumentationMetadata parseFrom(ByteBuffer data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Databricks.DocumentationMetadata parseFrom(ByteBuffer data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Databricks.DocumentationMetadata parseFrom(com.google.protobuf.ByteString data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Databricks.DocumentationMetadata parseFrom(com.google.protobuf.ByteString data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Databricks.DocumentationMetadata parseFrom(byte[] data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Databricks.DocumentationMetadata parseFrom(byte[] data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Databricks.DocumentationMetadata parseFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseFrom

public static Databricks.DocumentationMetadata parseFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static Databricks.DocumentationMetadata parseDelimitedFrom(InputStream input)
                                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static Databricks.DocumentationMetadata parseDelimitedFrom(InputStream input,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws IOException

Throws:

IOException

parseFrom

public static Databricks.DocumentationMetadata parseFrom(com.google.protobuf.CodedInputStream input)
                                                  throws IOException

Throws:

IOException

parseFrom

public static Databricks.DocumentationMetadata parseFrom(com.google.protobuf.CodedInputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

newBuilderForType

public Databricks.DocumentationMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Databricks.DocumentationMetadata.Builder newBuilder()

newBuilder

public static Databricks.DocumentationMetadata.Builder newBuilder(Databricks.DocumentationMetadata prototype)

toBuilder

public Databricks.DocumentationMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Databricks.DocumentationMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Databricks.DocumentationMetadata getDefaultInstance()

parser

public static com.google.protobuf.Parser<Databricks.DocumentationMetadata> parser()

getParserForType

public com.google.protobuf.Parser<Databricks.DocumentationMetadata> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Databricks.DocumentationMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder