com.databricks.api.proto.databricks

Interface Databricks.DocumentationMetadataOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Databricks.DocumentationMetadata, Databricks.DocumentationMetadata.Builder

Enclosing class:

Databricks

public static interface Databricks.DocumentationMetadataOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
List<String>	getOriginalProtoPathList() The original proto path in the internal representation.
int	getPosition() The location (line number) of the start of the documentation.
Databricks.Visibility	getVisibility() The visibility level when the docstring was generated.
boolean	hasDocstring() The string of documentation attached to this particular item.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasDocstring

boolean hasDocstring()

 The string of documentation attached to this particular item.
 

optional string docstring = 1;

getDocstring

String getDocstring()

 The string of documentation attached to this particular item.
 

optional string docstring = 1;

getDocstringBytes

com.google.protobuf.ByteString getDocstringBytes()

 The string of documentation attached to this particular item.
 

optional string docstring = 1;

hasLeadDoc

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;

getLeadDoc

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;

getLeadDocBytes

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;

hasVisibility

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;

getVisibility

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;

getOriginalProtoPathList

List<String> 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;

getOriginalProtoPathCount

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;

getOriginalProtoPath

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;

getOriginalProtoPathBytes

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;

hasPosition

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;

getPosition

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;