Class WorkerSettings (0.17.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

Implements

WorkerSettingsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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()

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

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

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()

string temp_storage_prefix = 6;

Returns
Type	Description
`ByteString`	The bytes for tempStoragePrefix.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
`UnknownFieldSet`

Overrides

GeneratedMessageV3.getUnknownFields()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public WorkerSettings.Builder toBuilder()

Returns
Type	Description
`WorkerSettings.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`