Class Task.NotebookTaskConfig (1.28.0)

public static final class Task.NotebookTaskConfig extends GeneratedMessageV3 implements Task.NotebookTaskConfigOrBuilder

Config for running scheduled notebooks.

Protobuf type google.cloud.dataplex.v1.Task.NotebookTaskConfig

Static Fields

ARCHIVE_URIS_FIELD_NUMBER

public static final int ARCHIVE_URIS_FIELD_NUMBER
Field Value
TypeDescription
int

FILE_URIS_FIELD_NUMBER

public static final int FILE_URIS_FIELD_NUMBER
Field Value
TypeDescription
int

INFRASTRUCTURE_SPEC_FIELD_NUMBER

public static final int INFRASTRUCTURE_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

NOTEBOOK_FIELD_NUMBER

public static final int NOTEBOOK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Task.NotebookTaskConfig getDefaultInstance()
Returns
TypeDescription
Task.NotebookTaskConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Task.NotebookTaskConfig.Builder newBuilder()
Returns
TypeDescription
Task.NotebookTaskConfig.Builder

newBuilder(Task.NotebookTaskConfig prototype)

public static Task.NotebookTaskConfig.Builder newBuilder(Task.NotebookTaskConfig prototype)
Parameter
NameDescription
prototypeTask.NotebookTaskConfig
Returns
TypeDescription
Task.NotebookTaskConfig.Builder

parseDelimitedFrom(InputStream input)

public static Task.NotebookTaskConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Task.NotebookTaskConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.NotebookTaskConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.NotebookTaskConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Task.NotebookTaskConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Task.NotebookTaskConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Task.NotebookTaskConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.NotebookTaskConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Task.NotebookTaskConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Task.NotebookTaskConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Task.NotebookTaskConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.NotebookTaskConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Task.NotebookTaskConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Task.NotebookTaskConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.NotebookTaskConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.NotebookTaskConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Task.NotebookTaskConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Task.NotebookTaskConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.NotebookTaskConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.NotebookTaskConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Task.NotebookTaskConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Task.NotebookTaskConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Task.NotebookTaskConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.NotebookTaskConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Task.NotebookTaskConfig> parser()
Returns
TypeDescription
Parser<NotebookTaskConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getArchiveUris(int index)

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];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The archiveUris at the given index.

getArchiveUrisBytes(int index)

public 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];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the archiveUris at the given index.

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];

Returns
TypeDescription
int

The count of archiveUris.

getArchiveUrisList()

public 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];

Returns
TypeDescription
ProtocolStringList

A list containing the archiveUris.

getDefaultInstanceForType()

public Task.NotebookTaskConfig getDefaultInstanceForType()
Returns
TypeDescription
Task.NotebookTaskConfig

getFileUris(int index)

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];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The fileUris at the given index.

getFileUrisBytes(int index)

public 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];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the fileUris at the given index.

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];

Returns
TypeDescription
int

The count of fileUris.

getFileUrisList()

public 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];

Returns
TypeDescription
ProtocolStringList

A list containing the fileUris.

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];

Returns
TypeDescription
Task.InfrastructureSpec

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];

Returns
TypeDescription
Task.InfrastructureSpecOrBuilder

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];

Returns
TypeDescription
String

The notebook.

getNotebookBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for notebook.

getParserForType()

public Parser<Task.NotebookTaskConfig> getParserForType()
Returns
TypeDescription
Parser<NotebookTaskConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasInfrastructureSpec()

public boolean hasInfrastructureSpec()

Optional. Infrastructure specification for the execution.

.google.cloud.dataplex.v1.Task.InfrastructureSpec infrastructure_spec = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the infrastructureSpec field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Task.NotebookTaskConfig.Builder newBuilderForType()
Returns
TypeDescription
Task.NotebookTaskConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Task.NotebookTaskConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Task.NotebookTaskConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Task.NotebookTaskConfig.Builder toBuilder()
Returns
TypeDescription
Task.NotebookTaskConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException