Class WorkerSettings.Builder (0.58.0)

Version 0.58.0

• 0.59.0 (latest)
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.5.0

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WorkerSettings.Builder

Implements

WorkerSettingsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WorkerSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
WorkerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public WorkerSettings build()

Returns
Type	Description
WorkerSettings

buildPartial()

public WorkerSettings buildPartial()

Returns
Type	Description
WorkerSettings

clear()

public WorkerSettings.Builder clear()

Returns
Type	Description
WorkerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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
Type	Description
WorkerSettings.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public WorkerSettings.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
WorkerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public WorkerSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
WorkerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearReportingEnabled()

public WorkerSettings.Builder clearReportingEnabled()

Whether to send work progress updates to the service.

bool reporting_enabled = 2;

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
WorkerSettings.Builder	This builder for chaining.

clearWorkerId()

public WorkerSettings.Builder clearWorkerId()

The ID of the worker running this pipeline.

string worker_id = 5;

Returns
Type	Description
WorkerSettings.Builder	This builder for chaining.

clone()

public WorkerSettings.Builder clone()

Returns
Type	Description
WorkerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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
Type	Description
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
Type	Description
ByteString	The bytes for baseUrl.

getDefaultInstanceForType()

public WorkerSettings getDefaultInstanceForType()

Returns
Type	Description
WorkerSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getReportingEnabled()

public boolean getReportingEnabled()

Whether to send work progress updates to the service.

bool reporting_enabled = 2;

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
ByteString	The bytes for tempStoragePrefix.

getWorkerId()

public String getWorkerId()

The ID of the worker running this pipeline.

string worker_id = 5;

Returns
Type	Description
String	The workerId.

getWorkerIdBytes()

public ByteString getWorkerIdBytes()

The ID of the worker running this pipeline.

string worker_id = 5;

Returns
Type	Description
ByteString	The bytes for workerId.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(WorkerSettings other)

public WorkerSettings.Builder mergeFrom(WorkerSettings other)

Parameter
Name	Description
other	WorkerSettings

Returns
Type	Description
WorkerSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WorkerSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
WorkerSettings.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public WorkerSettings.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
WorkerSettings.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WorkerSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
WorkerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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
Name	Description
value	String The baseUrl to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for baseUrl to set.

Returns
Type	Description
WorkerSettings.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public WorkerSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
WorkerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
WorkerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setReportingEnabled(boolean value)

public WorkerSettings.Builder setReportingEnabled(boolean value)

Whether to send work progress updates to the service.

bool reporting_enabled = 2;

Parameter
Name	Description
value	boolean The reportingEnabled to set.

Returns
Type	Description
WorkerSettings.Builder	This builder for chaining.

setServicePath(String value)

public WorkerSettings.Builder setServicePath(String value)

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

string service_path = 3;

Parameter
Name	Description
value	String The servicePath to set.

Returns
Type	Description
WorkerSettings.Builder	This builder for chaining.

setServicePathBytes(ByteString value)

public WorkerSettings.Builder setServicePathBytes(ByteString value)

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

string service_path = 3;

Parameter
Name	Description
value	ByteString The bytes for servicePath to set.

Returns
Type	Description
WorkerSettings.Builder	This builder for chaining.

setShuffleServicePath(String value)

public WorkerSettings.Builder setShuffleServicePath(String value)

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

string shuffle_service_path = 4;

Parameter
Name	Description
value	String The shuffleServicePath to set.

Returns
Type	Description
WorkerSettings.Builder	This builder for chaining.

setShuffleServicePathBytes(ByteString value)

public WorkerSettings.Builder setShuffleServicePathBytes(ByteString value)

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

string shuffle_service_path = 4;

Parameter
Name	Description
value	ByteString The bytes for shuffleServicePath to set.

Returns
Type	Description
WorkerSettings.Builder	This builder for chaining.

setTempStoragePrefix(String value)

public WorkerSettings.Builder setTempStoragePrefix(String value)

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;

Parameter
Name	Description
value	String The tempStoragePrefix to set.

Returns
Type	Description
WorkerSettings.Builder	This builder for chaining.

setTempStoragePrefixBytes(ByteString value)

public WorkerSettings.Builder setTempStoragePrefixBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for tempStoragePrefix to set.

Returns
Type	Description
WorkerSettings.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final WorkerSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
WorkerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setWorkerId(String value)

public WorkerSettings.Builder setWorkerId(String value)

The ID of the worker running this pipeline.

string worker_id = 5;

Parameter
Name	Description
value	String The workerId to set.

Returns
Type	Description
WorkerSettings.Builder	This builder for chaining.

setWorkerIdBytes(ByteString value)

public WorkerSettings.Builder setWorkerIdBytes(ByteString value)

The ID of the worker running this pipeline.

string worker_id = 5;

Parameter
Name	Description
value	ByteString The bytes for workerId to set.

Returns
Type	Description
WorkerSettings.Builder	This builder for chaining.