Class WorkerSettings

public final class WorkerSettings extends GeneratedMessageV3 implements WorkerSettingsOrBuilder

Provides data to pass through to the worker harness.

Protobuf type google.dataflow.v1beta3.WorkerSettings

Static Fields

BASE_URL_FIELD_NUMBER

public static final int BASE_URL_FIELD_NUMBER
Field Value
TypeDescription
int

REPORTING_ENABLED_FIELD_NUMBER

public static final int REPORTING_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_PATH_FIELD_NUMBER

public static final int SERVICE_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

SHUFFLE_SERVICE_PATH_FIELD_NUMBER

public static final int SHUFFLE_SERVICE_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

TEMP_STORAGE_PREFIX_FIELD_NUMBER

public static final int TEMP_STORAGE_PREFIX_FIELD_NUMBER
Field Value
TypeDescription
int

WORKER_ID_FIELD_NUMBER

public static final int WORKER_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static WorkerSettings getDefaultInstance()
Returns
TypeDescription
WorkerSettings

getDescriptor()

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

newBuilder()

public static WorkerSettings.Builder newBuilder()
Returns
TypeDescription
WorkerSettings.Builder

newBuilder(WorkerSettings prototype)

public static WorkerSettings.Builder newBuilder(WorkerSettings prototype)
Parameter
NameDescription
prototypeWorkerSettings
Returns
TypeDescription
WorkerSettings.Builder

parseDelimitedFrom(InputStream input)

public static WorkerSettings parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
WorkerSettings
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkerSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkerSettings
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static WorkerSettings parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
WorkerSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WorkerSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkerSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WorkerSettings parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
WorkerSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WorkerSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkerSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WorkerSettings parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
WorkerSettings
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkerSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkerSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static WorkerSettings parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
WorkerSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkerSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkerSettings
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static WorkerSettings parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
WorkerSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WorkerSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkerSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<WorkerSettings> parser()
Returns
TypeDescription
Parser<WorkerSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
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

getParserForType()

public Parser<WorkerSettings> getParserForType()
Returns
TypeDescription
Parser<WorkerSettings>
Overrides

getReportingEnabled()

public boolean getReportingEnabled()

Whether to send work progress updates to the service.

bool reporting_enabled = 2;

Returns
TypeDescription
boolean

The reportingEnabled.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public WorkerSettings.Builder newBuilderForType()
Returns
TypeDescription
WorkerSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WorkerSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
WorkerSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public WorkerSettings.Builder toBuilder()
Returns
TypeDescription
WorkerSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException