Class Task.NotebookTaskConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.Task.NotebookTaskConfig
All Implemented Interfaces:
Task.NotebookTaskConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Task

public static final class Task.NotebookTaskConfig extends com.google.protobuf.GeneratedMessage implements Task.NotebookTaskConfigOrBuilder
 Config for running scheduled notebooks.
 
Protobuf type google.cloud.dataplex.v1.Task.NotebookTaskConfig
See Also:
  • Field Details

    • NOTEBOOK_FIELD_NUMBER

      public static final int NOTEBOOK_FIELD_NUMBER
      See Also:
    • INFRASTRUCTURE_SPEC_FIELD_NUMBER

      public static final int INFRASTRUCTURE_SPEC_FIELD_NUMBER
      See Also:
    • FILE_URIS_FIELD_NUMBER

      public static final int FILE_URIS_FIELD_NUMBER
      See Also:
    • ARCHIVE_URIS_FIELD_NUMBER

      public static final int ARCHIVE_URIS_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
    • getNotebook

      public String getNotebook()
       Required. Path to input notebook. This can be the Cloud Storage URI of
       the notebook file or the path to a Notebook Content. The execution args
       are accessible as environment variables
       (`TASK_key=value`).
       
      string notebook = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNotebook in interface Task.NotebookTaskConfigOrBuilder
      Returns:
      The notebook.
    • getNotebookBytes

      public com.google.protobuf.ByteString getNotebookBytes()
       Required. Path to input notebook. This can be the Cloud Storage URI of
       the notebook file or the path to a Notebook Content. The execution args
       are accessible as environment variables
       (`TASK_key=value`).
       
      string notebook = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNotebookBytes in interface Task.NotebookTaskConfigOrBuilder
      Returns:
      The bytes for notebook.
    • hasInfrastructureSpec

      public boolean hasInfrastructureSpec()
       Optional. Infrastructure specification for the execution.
       
      .google.cloud.dataplex.v1.Task.InfrastructureSpec infrastructure_spec = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasInfrastructureSpec in interface Task.NotebookTaskConfigOrBuilder
      Returns:
      Whether the infrastructureSpec field is set.
    • getInfrastructureSpec

      public Task.InfrastructureSpec getInfrastructureSpec()
       Optional. Infrastructure specification for the execution.
       
      .google.cloud.dataplex.v1.Task.InfrastructureSpec infrastructure_spec = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInfrastructureSpec in interface Task.NotebookTaskConfigOrBuilder
      Returns:
      The infrastructureSpec.
    • getInfrastructureSpecOrBuilder

      public Task.InfrastructureSpecOrBuilder getInfrastructureSpecOrBuilder()
       Optional. Infrastructure specification for the execution.
       
      .google.cloud.dataplex.v1.Task.InfrastructureSpec infrastructure_spec = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInfrastructureSpecOrBuilder in interface Task.NotebookTaskConfigOrBuilder
    • getFileUrisList

      public com.google.protobuf.ProtocolStringList getFileUrisList()
       Optional. Cloud Storage URIs of files to be placed in the working
       directory of each executor.
       
      repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFileUrisList in interface Task.NotebookTaskConfigOrBuilder
      Returns:
      A list containing the fileUris.
    • getFileUrisCount

      public int getFileUrisCount()
       Optional. Cloud Storage URIs of files to be placed in the working
       directory of each executor.
       
      repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFileUrisCount in interface Task.NotebookTaskConfigOrBuilder
      Returns:
      The count of fileUris.
    • getFileUris

      public String getFileUris(int index)
       Optional. Cloud Storage URIs of files to be placed in the working
       directory of each executor.
       
      repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFileUris in interface Task.NotebookTaskConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The fileUris at the given index.
    • getFileUrisBytes

      public com.google.protobuf.ByteString getFileUrisBytes(int index)
       Optional. Cloud Storage URIs of files to be placed in the working
       directory of each executor.
       
      repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFileUrisBytes in interface Task.NotebookTaskConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the fileUris at the given index.
    • getArchiveUrisList

      public com.google.protobuf.ProtocolStringList getArchiveUrisList()
       Optional. Cloud Storage URIs of archives to be extracted into the working
       directory of each executor. Supported file types: .jar, .tar, .tar.gz,
       .tgz, and .zip.
       
      repeated string archive_uris = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArchiveUrisList in interface Task.NotebookTaskConfigOrBuilder
      Returns:
      A list containing the archiveUris.
    • getArchiveUrisCount

      public int getArchiveUrisCount()
       Optional. Cloud Storage URIs of archives to be extracted into the working
       directory of each executor. Supported file types: .jar, .tar, .tar.gz,
       .tgz, and .zip.
       
      repeated string archive_uris = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArchiveUrisCount in interface Task.NotebookTaskConfigOrBuilder
      Returns:
      The count of archiveUris.
    • getArchiveUris

      public String getArchiveUris(int index)
       Optional. Cloud Storage URIs of archives to be extracted into the working
       directory of each executor. Supported file types: .jar, .tar, .tar.gz,
       .tgz, and .zip.
       
      repeated string archive_uris = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArchiveUris in interface Task.NotebookTaskConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The archiveUris at the given index.
    • getArchiveUrisBytes

      public com.google.protobuf.ByteString getArchiveUrisBytes(int index)
       Optional. Cloud Storage URIs of archives to be extracted into the working
       directory of each executor. Supported file types: .jar, .tar, .tar.gz,
       .tgz, and .zip.
       
      repeated string archive_uris = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArchiveUrisBytes in interface Task.NotebookTaskConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the archiveUris 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 Task.NotebookTaskConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

      public static Task.NotebookTaskConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

      public static Task.NotebookTaskConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static Task.NotebookTaskConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static Task.NotebookTaskConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static Task.NotebookTaskConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static Task.NotebookTaskConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static Task.NotebookTaskConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public Task.NotebookTaskConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static Task.NotebookTaskConfig.Builder newBuilder()
    • newBuilder

      public static Task.NotebookTaskConfig.Builder newBuilder(Task.NotebookTaskConfig prototype)
    • toBuilder

      public Task.NotebookTaskConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected Task.NotebookTaskConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static Task.NotebookTaskConfig getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<Task.NotebookTaskConfig> parser()
    • getParserForType

      public com.google.protobuf.Parser<Task.NotebookTaskConfig> 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 Task.NotebookTaskConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder