GoogleCloudStorageReadSettings Class

public final class GoogleCloudStorageReadSettings
extends StoreReadSettings

Google Cloud Storage read settings.

Constructor Summary

Constructor Description
GoogleCloudStorageReadSettings()

Creates an instance of GoogleCloudStorageReadSettings class.

Method Summary

Modifier and Type Method and Description
Object deleteFilesAfterCompletion()

Get the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion.

Object enablePartitionDiscovery()

Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery.

Object fileListPath()

Get the fileListPath property: Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy.

static GoogleCloudStorageReadSettings fromJson(JsonReader jsonReader)

Reads an instance of GoogleCloudStorageReadSettings from the JsonReader.

Object modifiedDatetimeEnd()

Get the modifiedDatetimeEnd property: The end of file's modified datetime.

Object modifiedDatetimeStart()

Get the modifiedDatetimeStart property: The start of file's modified datetime.

Object partitionRootPath()

Get the partitionRootPath property: Specify the root path where partition discovery starts from.

Object prefix()

Get the prefix property: The prefix filter for the Google Cloud Storage object name.

Object recursive()

Get the recursive property: If true, files under the folder path will be read recursively.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The read setting type.

void validate()

Validates the instance.

Object wildcardFileName()

Get the wildcardFileName property: Google Cloud Storage wildcardFileName.

Object wildcardFolderPath()

Get the wildcardFolderPath property: Google Cloud Storage wildcardFolderPath.

GoogleCloudStorageReadSettings withDeleteFilesAfterCompletion(Object deleteFilesAfterCompletion)

Set the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion.

GoogleCloudStorageReadSettings withDisableMetricsCollection(Object disableMetricsCollection)

Set the disableMetricsCollection property: If true, disable data store metrics collection.

GoogleCloudStorageReadSettings withEnablePartitionDiscovery(Object enablePartitionDiscovery)

Set the enablePartitionDiscovery property: Indicates whether to enable partition discovery.

GoogleCloudStorageReadSettings withFileListPath(Object fileListPath)

Set the fileListPath property: Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy.

GoogleCloudStorageReadSettings withMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.

GoogleCloudStorageReadSettings withModifiedDatetimeEnd(Object modifiedDatetimeEnd)

Set the modifiedDatetimeEnd property: The end of file's modified datetime.

GoogleCloudStorageReadSettings withModifiedDatetimeStart(Object modifiedDatetimeStart)

Set the modifiedDatetimeStart property: The start of file's modified datetime.

GoogleCloudStorageReadSettings withPartitionRootPath(Object partitionRootPath)

Set the partitionRootPath property: Specify the root path where partition discovery starts from.

GoogleCloudStorageReadSettings withPrefix(Object prefix)

Set the prefix property: The prefix filter for the Google Cloud Storage object name.

GoogleCloudStorageReadSettings withRecursive(Object recursive)

Set the recursive property: If true, files under the folder path will be read recursively.

GoogleCloudStorageReadSettings withWildcardFileName(Object wildcardFileName)

Set the wildcardFileName property: Google Cloud Storage wildcardFileName.

GoogleCloudStorageReadSettings withWildcardFolderPath(Object wildcardFolderPath)

Set the wildcardFolderPath property: Google Cloud Storage wildcardFolderPath.

Methods inherited from StoreReadSettings

Methods inherited from java.lang.Object

Constructor Details

GoogleCloudStorageReadSettings

public GoogleCloudStorageReadSettings()

Creates an instance of GoogleCloudStorageReadSettings class.

Method Details

deleteFilesAfterCompletion

public Object deleteFilesAfterCompletion()

Get the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

Returns:

the deleteFilesAfterCompletion value.

enablePartitionDiscovery

public Object enablePartitionDiscovery()

Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).

Returns:

the enablePartitionDiscovery value.

fileListPath

public Object fileListPath()

Get the fileListPath property: Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

Returns:

the fileListPath value.

fromJson

public static GoogleCloudStorageReadSettings fromJson(JsonReader jsonReader)

Reads an instance of GoogleCloudStorageReadSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of GoogleCloudStorageReadSettings if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the GoogleCloudStorageReadSettings.

modifiedDatetimeEnd

public Object modifiedDatetimeEnd()

Get the modifiedDatetimeEnd property: The end of file's modified datetime. Type: string (or Expression with resultType string).

Returns:

the modifiedDatetimeEnd value.

modifiedDatetimeStart

public Object modifiedDatetimeStart()

Get the modifiedDatetimeStart property: The start of file's modified datetime. Type: string (or Expression with resultType string).

Returns:

the modifiedDatetimeStart value.

partitionRootPath

public Object partitionRootPath()

Get the partitionRootPath property: Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

Returns:

the partitionRootPath value.

prefix

public Object prefix()

Get the prefix property: The prefix filter for the Google Cloud Storage object name. Type: string (or Expression with resultType string).

Returns:

the prefix value.

recursive

public Object recursive()

Get the recursive property: If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

Returns:

the recursive value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

GoogleCloudStorageReadSettings.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The read setting type.

Overrides:

GoogleCloudStorageReadSettings.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

GoogleCloudStorageReadSettings.validate()

wildcardFileName

public Object wildcardFileName()

Get the wildcardFileName property: Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string).

Returns:

the wildcardFileName value.

wildcardFolderPath

public Object wildcardFolderPath()

Get the wildcardFolderPath property: Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string).

Returns:

the wildcardFolderPath value.

withDeleteFilesAfterCompletion

public GoogleCloudStorageReadSettings withDeleteFilesAfterCompletion(Object deleteFilesAfterCompletion)

Set the deleteFilesAfterCompletion property: Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

Parameters:

deleteFilesAfterCompletion - the deleteFilesAfterCompletion value to set.

Returns:

the GoogleCloudStorageReadSettings object itself.

withDisableMetricsCollection

public GoogleCloudStorageReadSettings withDisableMetricsCollection(Object disableMetricsCollection)

Set the disableMetricsCollection property: If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

Overrides:

GoogleCloudStorageReadSettings.withDisableMetricsCollection(Object disableMetricsCollection)

Parameters:

disableMetricsCollection

withEnablePartitionDiscovery

public GoogleCloudStorageReadSettings withEnablePartitionDiscovery(Object enablePartitionDiscovery)

Set the enablePartitionDiscovery property: Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).

Parameters:

enablePartitionDiscovery - the enablePartitionDiscovery value to set.

Returns:

the GoogleCloudStorageReadSettings object itself.

withFileListPath

public GoogleCloudStorageReadSettings withFileListPath(Object fileListPath)

Set the fileListPath property: Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

Parameters:

fileListPath - the fileListPath value to set.

Returns:

the GoogleCloudStorageReadSettings object itself.

withMaxConcurrentConnections

public GoogleCloudStorageReadSettings withMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

Overrides:

GoogleCloudStorageReadSettings.withMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

withModifiedDatetimeEnd

public GoogleCloudStorageReadSettings withModifiedDatetimeEnd(Object modifiedDatetimeEnd)

Set the modifiedDatetimeEnd property: The end of file's modified datetime. Type: string (or Expression with resultType string).

Parameters:

modifiedDatetimeEnd - the modifiedDatetimeEnd value to set.

Returns:

the GoogleCloudStorageReadSettings object itself.

withModifiedDatetimeStart

public GoogleCloudStorageReadSettings withModifiedDatetimeStart(Object modifiedDatetimeStart)

Set the modifiedDatetimeStart property: The start of file's modified datetime. Type: string (or Expression with resultType string).

Parameters:

modifiedDatetimeStart - the modifiedDatetimeStart value to set.

Returns:

the GoogleCloudStorageReadSettings object itself.

withPartitionRootPath

public GoogleCloudStorageReadSettings withPartitionRootPath(Object partitionRootPath)

Set the partitionRootPath property: Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

Parameters:

partitionRootPath - the partitionRootPath value to set.

Returns:

the GoogleCloudStorageReadSettings object itself.

withPrefix

public GoogleCloudStorageReadSettings withPrefix(Object prefix)

Set the prefix property: The prefix filter for the Google Cloud Storage object name. Type: string (or Expression with resultType string).

Parameters:

prefix - the prefix value to set.

Returns:

the GoogleCloudStorageReadSettings object itself.

withRecursive

public GoogleCloudStorageReadSettings withRecursive(Object recursive)

Set the recursive property: If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

Parameters:

recursive - the recursive value to set.

Returns:

the GoogleCloudStorageReadSettings object itself.

withWildcardFileName

public GoogleCloudStorageReadSettings withWildcardFileName(Object wildcardFileName)

Set the wildcardFileName property: Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string).

Parameters:

wildcardFileName - the wildcardFileName value to set.

Returns:

the GoogleCloudStorageReadSettings object itself.

withWildcardFolderPath

public GoogleCloudStorageReadSettings withWildcardFolderPath(Object wildcardFolderPath)

Set the wildcardFolderPath property: Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string).

Parameters:

wildcardFolderPath - the wildcardFolderPath value to set.

Returns:

the GoogleCloudStorageReadSettings object itself.

Applies to