Class WorkerSettings (0.57.0) 

public final class WorkerSettings extends GeneratedMessageV3 implements WorkerSettingsOrBuilder

Provides data to pass through to the worker harness.

Protobuf type google.dataflow.v1beta3.WorkerSettings

Inheritance

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

Static Fields

BASE_URL_FIELD_NUMBER

public static final int BASE_URL_FIELD_NUMBER
Field Value
Type Description
int

REPORTING_ENABLED_FIELD_NUMBER

public static final int REPORTING_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_PATH_FIELD_NUMBER

public static final int SERVICE_PATH_FIELD_NUMBER
Field Value
Type Description
int

SHUFFLE_SERVICE_PATH_FIELD_NUMBER

public static final int SHUFFLE_SERVICE_PATH_FIELD_NUMBER
Field Value
Type Description
int

TEMP_STORAGE_PREFIX_FIELD_NUMBER

public static final int TEMP_STORAGE_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

WORKER_ID_FIELD_NUMBER

public static final int WORKER_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WorkerSettings getDefaultInstance()
Returns
Type Description
WorkerSettings

getDescriptor()

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

newBuilder()

public static WorkerSettings.Builder newBuilder()
Returns
Type Description
WorkerSettings.Builder

newBuilder(WorkerSettings prototype)

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

parseDelimitedFrom(InputStream input)

public static WorkerSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WorkerSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static WorkerSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WorkerSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static WorkerSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WorkerSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static WorkerSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WorkerSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static WorkerSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WorkerSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<WorkerSettings> parser()
Returns
Type Description
Parser<WorkerSettings>

Methods

equals(Object obj)

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

getParserForType()

public Parser<WorkerSettings> getParserForType()
Returns
Type Description
Parser<WorkerSettings>
Overrides

getReportingEnabled()

public boolean getReportingEnabled()

Whether to send work progress updates to the service.

bool reporting_enabled = 2;

Returns
Type Description
boolean

The reportingEnabled.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 WorkerSettings.Builder newBuilderForType()
Returns
Type Description
WorkerSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public WorkerSettings.Builder toBuilder()
Returns
Type Description
WorkerSettings.Builder

writeTo(CodedOutputStream output)

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