Package com.google.cloud.dataplex.v1

Class DataDocumentationSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.DataDocumentationSpec
All Implemented Interfaces:
DataDocumentationSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DataDocumentationSpec extends com.google.protobuf.GeneratedMessage implements DataDocumentationSpecOrBuilder
 DataDocumentation scan related spec.
Protobuf type google.cloud.dataplex.v1.DataDocumentationSpec
See Also:

  • Field Details

    • CATALOG_PUBLISHING_ENABLED_FIELD_NUMBER

      public static final int CATALOG_PUBLISHING_ENABLED_FIELD_NUMBER
      See Also:

    • GENERATION_SCOPES_FIELD_NUMBER

      public static final int GENERATION_SCOPES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getCatalogPublishingEnabled

      public boolean getCatalogPublishingEnabled()
       Optional. Whether to publish result to Dataplex Catalog.
      bool catalog_publishing_enabled = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCatalogPublishingEnabled in interface DataDocumentationSpecOrBuilder
      Returns:
      The catalogPublishingEnabled.

    • getGenerationScopesList

      public List<DataDocumentationSpec.GenerationScope> getGenerationScopesList()
       Optional. Specifies which components of the data documentation to generate.
 Any component that is required to generate the specified components will
 also be generated. If no generation scope is specified, all available
 documentation components will be generated.
      repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGenerationScopesList in interface DataDocumentationSpecOrBuilder
      Returns:
      A list containing the generationScopes.

    • getGenerationScopesCount

      public int getGenerationScopesCount()
       Optional. Specifies which components of the data documentation to generate.
 Any component that is required to generate the specified components will
 also be generated. If no generation scope is specified, all available
 documentation components will be generated.
      repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGenerationScopesCount in interface DataDocumentationSpecOrBuilder
      Returns:
      The count of generationScopes.

    • getGenerationScopes

      public DataDocumentationSpec.GenerationScope getGenerationScopes(int index)
       Optional. Specifies which components of the data documentation to generate.
 Any component that is required to generate the specified components will
 also be generated. If no generation scope is specified, all available
 documentation components will be generated.
      repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGenerationScopes in interface DataDocumentationSpecOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The generationScopes at the given index.

    • getGenerationScopesValueList

      public List<Integer> getGenerationScopesValueList()
       Optional. Specifies which components of the data documentation to generate.
 Any component that is required to generate the specified components will
 also be generated. If no generation scope is specified, all available
 documentation components will be generated.
      repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGenerationScopesValueList in interface DataDocumentationSpecOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for generationScopes.

    • getGenerationScopesValue

      public int getGenerationScopesValue(int index)
       Optional. Specifies which components of the data documentation to generate.
 Any component that is required to generate the specified components will
 also be generated. If no generation scope is specified, all available
 documentation components will be generated.
      repeated .google.cloud.dataplex.v1.DataDocumentationSpec.GenerationScope generation_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGenerationScopesValue in interface DataDocumentationSpecOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of generationScopes at the given index.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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 DataDocumentationSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataDocumentationSpec parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataDocumentationSpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataDocumentationSpec parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataDocumentationSpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataDocumentationSpec parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataDocumentationSpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataDocumentationSpec parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataDocumentationSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataDocumentationSpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataDocumentationSpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataDocumentationSpec parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DataDocumentationSpec.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DataDocumentationSpec.Builder newBuilder()

    • newBuilder

      public static DataDocumentationSpec.Builder newBuilder(DataDocumentationSpec prototype)

    • toBuilder

      public DataDocumentationSpec.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DataDocumentationSpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DataDocumentationSpec getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DataDocumentationSpec> 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.GeneratedMessage

    • getDefaultInstanceForType

      public DataDocumentationSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder