Class Task.NotebookTaskConfig.Builder (1.44.0)

public static final class Task.NotebookTaskConfig.Builder extends GeneratedMessageV3.Builder<Task.NotebookTaskConfig.Builder> implements Task.NotebookTaskConfigOrBuilder

Config for running scheduled notebooks.

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

Static Methods

getDescriptor()

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

Methods

addAllArchiveUris(Iterable<String> values)

public Task.NotebookTaskConfig.Builder addAllArchiveUris(Iterable<String> values)

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
values Iterable<String>

The archiveUris to add.

Returns
Type Description
Task.NotebookTaskConfig.Builder

This builder for chaining.

addAllFileUris(Iterable<String> values)

public Task.NotebookTaskConfig.Builder addAllFileUris(Iterable<String> values)

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
values Iterable<String>

The fileUris to add.

Returns
Type Description
Task.NotebookTaskConfig.Builder

This builder for chaining.

addArchiveUris(String value)

public Task.NotebookTaskConfig.Builder addArchiveUris(String value)

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
value String

The archiveUris to add.

Returns
Type Description
Task.NotebookTaskConfig.Builder

This builder for chaining.

addArchiveUrisBytes(ByteString value)

public Task.NotebookTaskConfig.Builder addArchiveUrisBytes(ByteString value)

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
value ByteString

The bytes of the archiveUris to add.

Returns
Type Description
Task.NotebookTaskConfig.Builder

This builder for chaining.

addFileUris(String value)

public Task.NotebookTaskConfig.Builder addFileUris(String value)

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
value String

The fileUris to add.

Returns
Type Description
Task.NotebookTaskConfig.Builder

This builder for chaining.

addFileUrisBytes(ByteString value)

public Task.NotebookTaskConfig.Builder addFileUrisBytes(ByteString value)

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
value ByteString

The bytes of the fileUris to add.

Returns
Type Description
Task.NotebookTaskConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Task.NotebookTaskConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Task.NotebookTaskConfig.Builder
Overrides

build()

public Task.NotebookTaskConfig build()
Returns
Type Description
Task.NotebookTaskConfig

buildPartial()

public Task.NotebookTaskConfig buildPartial()
Returns
Type Description
Task.NotebookTaskConfig

clear()

public Task.NotebookTaskConfig.Builder clear()
Returns
Type Description
Task.NotebookTaskConfig.Builder
Overrides

clearArchiveUris()

public Task.NotebookTaskConfig.Builder clearArchiveUris()

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
Task.NotebookTaskConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Task.NotebookTaskConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Task.NotebookTaskConfig.Builder
Overrides

clearFileUris()

public Task.NotebookTaskConfig.Builder clearFileUris()

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
Task.NotebookTaskConfig.Builder

This builder for chaining.

clearInfrastructureSpec()

public Task.NotebookTaskConfig.Builder clearInfrastructureSpec()

Optional. Infrastructure specification for the execution.

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

Returns
Type Description
Task.NotebookTaskConfig.Builder

clearNotebook()

public Task.NotebookTaskConfig.Builder clearNotebook()

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
Task.NotebookTaskConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Task.NotebookTaskConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Task.NotebookTaskConfig.Builder
Overrides

clone()

public Task.NotebookTaskConfig.Builder clone()
Returns
Type Description
Task.NotebookTaskConfig.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getInfrastructureSpecBuilder()

public Task.InfrastructureSpec.Builder getInfrastructureSpecBuilder()

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.Builder

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Task.NotebookTaskConfig other)

public Task.NotebookTaskConfig.Builder mergeFrom(Task.NotebookTaskConfig other)
Parameter
Name Description
other Task.NotebookTaskConfig
Returns
Type Description
Task.NotebookTaskConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Task.NotebookTaskConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task.NotebookTaskConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Task.NotebookTaskConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Task.NotebookTaskConfig.Builder
Overrides

mergeInfrastructureSpec(Task.InfrastructureSpec value)

public Task.NotebookTaskConfig.Builder mergeInfrastructureSpec(Task.InfrastructureSpec value)

Optional. Infrastructure specification for the execution.

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

Parameter
Name Description
value Task.InfrastructureSpec
Returns
Type Description
Task.NotebookTaskConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Task.NotebookTaskConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Task.NotebookTaskConfig.Builder
Overrides

setArchiveUris(int index, String value)

public Task.NotebookTaskConfig.Builder setArchiveUris(int index, String value)

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

Parameters
Name Description
index int

The index to set the value at.

value String

The archiveUris to set.

Returns
Type Description
Task.NotebookTaskConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Task.NotebookTaskConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Task.NotebookTaskConfig.Builder
Overrides

setFileUris(int index, String value)

public Task.NotebookTaskConfig.Builder setFileUris(int index, String value)

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

Parameters
Name Description
index int

The index to set the value at.

value String

The fileUris to set.

Returns
Type Description
Task.NotebookTaskConfig.Builder

This builder for chaining.

setInfrastructureSpec(Task.InfrastructureSpec value)

public Task.NotebookTaskConfig.Builder setInfrastructureSpec(Task.InfrastructureSpec value)

Optional. Infrastructure specification for the execution.

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

Parameter
Name Description
value Task.InfrastructureSpec
Returns
Type Description
Task.NotebookTaskConfig.Builder

setInfrastructureSpec(Task.InfrastructureSpec.Builder builderForValue)

public Task.NotebookTaskConfig.Builder setInfrastructureSpec(Task.InfrastructureSpec.Builder builderForValue)

Optional. Infrastructure specification for the execution.

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

Parameter
Name Description
builderForValue Task.InfrastructureSpec.Builder
Returns
Type Description
Task.NotebookTaskConfig.Builder

setNotebook(String value)

public Task.NotebookTaskConfig.Builder setNotebook(String value)

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

Parameter
Name Description
value String

The notebook to set.

Returns
Type Description
Task.NotebookTaskConfig.Builder

This builder for chaining.

setNotebookBytes(ByteString value)

public Task.NotebookTaskConfig.Builder setNotebookBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for notebook to set.

Returns
Type Description
Task.NotebookTaskConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Task.NotebookTaskConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Task.NotebookTaskConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Task.NotebookTaskConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Task.NotebookTaskConfig.Builder
Overrides