Class Task.NotebookTaskConfig (1.44.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
Type Description
int

FILE_URIS_FIELD_NUMBER

public static final int FILE_URIS_FIELD_NUMBER
Field Value
Type Description
int

INFRASTRUCTURE_SPEC_FIELD_NUMBER

public static final int INFRASTRUCTURE_SPEC_FIELD_NUMBER
Field Value
Type Description
int

NOTEBOOK_FIELD_NUMBER

public static final int NOTEBOOK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Task.NotebookTaskConfig getDefaultInstance()
Returns
Type Description
Task.NotebookTaskConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Task.NotebookTaskConfig.Builder newBuilder()
Returns
Type Description
Task.NotebookTaskConfig.Builder

newBuilder(Task.NotebookTaskConfig prototype)

public static Task.NotebookTaskConfig.Builder newBuilder(Task.NotebookTaskConfig prototype)
Parameter
Name Description
prototype Task.NotebookTaskConfig
Returns
Type Description
Task.NotebookTaskConfig.Builder

parseDelimitedFrom(InputStream input)

public static Task.NotebookTaskConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Task.NotebookTaskConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.NotebookTaskConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task.NotebookTaskConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Task.NotebookTaskConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Task.NotebookTaskConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Task.NotebookTaskConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task.NotebookTaskConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Task.NotebookTaskConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Task.NotebookTaskConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Task.NotebookTaskConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task.NotebookTaskConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Task.NotebookTaskConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Task.NotebookTaskConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.NotebookTaskConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task.NotebookTaskConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Task.NotebookTaskConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Task.NotebookTaskConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.NotebookTaskConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task.NotebookTaskConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Task.NotebookTaskConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Task.NotebookTaskConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Task.NotebookTaskConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task.NotebookTaskConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
ProtocolStringList

A list containing the archiveUris.

getDefaultInstanceForType()

public Task.NotebookTaskConfig getDefaultInstanceForType()
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for notebook.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
boolean

Whether the infrastructureSpec field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Task.NotebookTaskConfig.Builder newBuilderForType()
Returns
Type Description
Task.NotebookTaskConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Task.NotebookTaskConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Task.NotebookTaskConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Task.NotebookTaskConfig.Builder toBuilder()
Returns
Type Description
Task.NotebookTaskConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException