Class WorkerSettings.Builder (0.10.0)

Stay organized with collections Save and categorize content based on your preferences.
public static final class WorkerSettings.Builder extends GeneratedMessageV3.Builder<WorkerSettings.Builder> implements WorkerSettingsOrBuilder

Provides data to pass through to the worker harness.

Protobuf type google.dataflow.v1beta3.WorkerSettings

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WorkerSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WorkerSettings.Builder
Overrides

build()

public WorkerSettings build()
Returns
TypeDescription
WorkerSettings

buildPartial()

public WorkerSettings buildPartial()
Returns
TypeDescription
WorkerSettings

clear()

public WorkerSettings.Builder clear()
Returns
TypeDescription
WorkerSettings.Builder
Overrides

clearBaseUrl()

public WorkerSettings.Builder clearBaseUrl()

The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"

string base_url = 1;

Returns
TypeDescription
WorkerSettings.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public WorkerSettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
WorkerSettings.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public WorkerSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
WorkerSettings.Builder
Overrides

clearReportingEnabled()

public WorkerSettings.Builder clearReportingEnabled()

Whether to send work progress updates to the service.

bool reporting_enabled = 2;

Returns
TypeDescription
WorkerSettings.Builder

This builder for chaining.

clearServicePath()

public WorkerSettings.Builder clearServicePath()

The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

string service_path = 3;

Returns
TypeDescription
WorkerSettings.Builder

This builder for chaining.

clearShuffleServicePath()

public WorkerSettings.Builder clearShuffleServicePath()

The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

string shuffle_service_path = 4;

Returns
TypeDescription
WorkerSettings.Builder

This builder for chaining.

clearTempStoragePrefix()

public WorkerSettings.Builder clearTempStoragePrefix()

The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

string temp_storage_prefix = 6;

Returns
TypeDescription
WorkerSettings.Builder

This builder for chaining.

clearWorkerId()

public WorkerSettings.Builder clearWorkerId()

The ID of the worker running this pipeline.

string worker_id = 5;

Returns
TypeDescription
WorkerSettings.Builder

This builder for chaining.

clone()

public WorkerSettings.Builder clone()
Returns
TypeDescription
WorkerSettings.Builder
Overrides

getBaseUrl()

public String getBaseUrl()

The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"

string base_url = 1;

Returns
TypeDescription
String

The baseUrl.

getBaseUrlBytes()

public ByteString getBaseUrlBytes()

The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"

string base_url = 1;

Returns
TypeDescription
ByteString

The bytes for baseUrl.

getDefaultInstanceForType()

public WorkerSettings getDefaultInstanceForType()
Returns
TypeDescription
WorkerSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getReportingEnabled()

public boolean getReportingEnabled()

Whether to send work progress updates to the service.

bool reporting_enabled = 2;

Returns
TypeDescription
boolean

The reportingEnabled.

getServicePath()

public String getServicePath()

The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

string service_path = 3;

Returns
TypeDescription
String

The servicePath.

getServicePathBytes()

public ByteString getServicePathBytes()

The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

string service_path = 3;

Returns
TypeDescription
ByteString

The bytes for servicePath.

getShuffleServicePath()

public String getShuffleServicePath()

The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

string shuffle_service_path = 4;

Returns
TypeDescription
String

The shuffleServicePath.

getShuffleServicePathBytes()

public ByteString getShuffleServicePathBytes()

The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

string shuffle_service_path = 4;

Returns
TypeDescription
ByteString

The bytes for shuffleServicePath.

getTempStoragePrefix()

public String getTempStoragePrefix()

The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

string temp_storage_prefix = 6;

Returns
TypeDescription
String

The tempStoragePrefix.

getTempStoragePrefixBytes()

public ByteString getTempStoragePrefixBytes()

The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

string temp_storage_prefix = 6;

Returns
TypeDescription
ByteString

The bytes for tempStoragePrefix.

getWorkerId()

public String getWorkerId()

The ID of the worker running this pipeline.

string worker_id = 5;

Returns
TypeDescription
String

The workerId.

getWorkerIdBytes()

public ByteString getWorkerIdBytes()

The ID of the worker running this pipeline.

string worker_id = 5;

Returns
TypeDescription
ByteString

The bytes for workerId.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(WorkerSettings other)

public WorkerSettings.Builder mergeFrom(WorkerSettings other)
Parameter
NameDescription
otherWorkerSettings
Returns
TypeDescription
WorkerSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WorkerSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkerSettings.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public WorkerSettings.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
WorkerSettings.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WorkerSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WorkerSettings.Builder
Overrides

setBaseUrl(String value)

public WorkerSettings.Builder setBaseUrl(String value)

The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"

string base_url = 1;

Parameter
NameDescription
valueString

The baseUrl to set.

Returns
TypeDescription
WorkerSettings.Builder

This builder for chaining.

setBaseUrlBytes(ByteString value)

public WorkerSettings.Builder setBaseUrlBytes(ByteString value)

The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"

string base_url = 1;

Parameter
NameDescription
valueByteString

The bytes for baseUrl to set.

Returns
TypeDescription
WorkerSettings.Builder

This builder