Package com.google.dataflow.v1beta3

Class WorkerSettings

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.dataflow.v1beta3.WorkerSettings
All Implemented Interfaces:
WorkerSettingsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class WorkerSettings extends com.google.protobuf.GeneratedMessage implements WorkerSettingsOrBuilder
 Provides data to pass through to the worker harness.
Protobuf type google.dataflow.v1beta3.WorkerSettings
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    WorkerSettings.Builder
    Provides data to pass through to the worker harness.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BASE_URL_FIELD_NUMBER
     
    static final int
    REPORTING_ENABLED_FIELD_NUMBER
     
    static final int
    SERVICE_PATH_FIELD_NUMBER
     
    static final int
    SHUFFLE_SERVICE_PATH_FIELD_NUMBER
     
    static final int
    TEMP_STORAGE_PREFIX_FIELD_NUMBER
     
    static final int
    WORKER_ID_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getBaseUrl()
    The base URL for accessing Google Cloud APIs.
    com.google.protobuf.ByteString
    getBaseUrlBytes()
    The base URL for accessing Google Cloud APIs.
    static WorkerSettings
    getDefaultInstance()
     
    WorkerSettings
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<WorkerSettings>
    getParserForType()
     
    boolean
    getReportingEnabled()
    Whether to send work progress updates to the service.
    int
    getSerializedSize()
     
    String
    getServicePath()
    The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
    com.google.protobuf.ByteString
    getServicePathBytes()
    The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
    String
    getShuffleServicePath()
    The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
    com.google.protobuf.ByteString
    getShuffleServicePathBytes()
    The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
    String
    getTempStoragePrefix()
    The prefix of the resources the system should use for temporary storage.
    com.google.protobuf.ByteString
    getTempStoragePrefixBytes()
    The prefix of the resources the system should use for temporary storage.
    String
    getWorkerId()
    The ID of the worker running this pipeline.
    com.google.protobuf.ByteString
    getWorkerIdBytes()
    The ID of the worker running this pipeline.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static WorkerSettings.Builder
    newBuilder()
     
    static WorkerSettings.Builder
    newBuilder(WorkerSettings prototype)
     
    WorkerSettings.Builder
    newBuilderForType()
     
    protected WorkerSettings.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static WorkerSettings
    parseDelimitedFrom(InputStream input)
     
    static WorkerSettings
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WorkerSettings
    parseFrom(byte[] data)
     
    static WorkerSettings
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WorkerSettings
    parseFrom(com.google.protobuf.ByteString data)
     
    static WorkerSettings
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WorkerSettings
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static WorkerSettings
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WorkerSettings
    parseFrom(InputStream input)
     
    static WorkerSettings
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WorkerSettings
    parseFrom(ByteBuffer data)
     
    static WorkerSettings
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<WorkerSettings>
    parser()
     
    WorkerSettings.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • BASE_URL_FIELD_NUMBER

      public static final int BASE_URL_FIELD_NUMBER
      See Also:

    • REPORTING_ENABLED_FIELD_NUMBER

      public static final int REPORTING_ENABLED_FIELD_NUMBER
      See Also:

    • SERVICE_PATH_FIELD_NUMBER

      public static final int SERVICE_PATH_FIELD_NUMBER
      See Also:

    • SHUFFLE_SERVICE_PATH_FIELD_NUMBER

      public static final int SHUFFLE_SERVICE_PATH_FIELD_NUMBER
      See Also:

    • WORKER_ID_FIELD_NUMBER

      public static final int WORKER_ID_FIELD_NUMBER
      See Also:

    • TEMP_STORAGE_PREFIX_FIELD_NUMBER

      public static final int TEMP_STORAGE_PREFIX_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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;
      Specified by:
      getBaseUrl in interface WorkerSettingsOrBuilder
      Returns:
      The baseUrl.

    • getBaseUrlBytes

      public com.google.protobuf.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;
      Specified by:
      getBaseUrlBytes in interface WorkerSettingsOrBuilder
      Returns:
      The bytes for baseUrl.

    • getReportingEnabled

      public boolean getReportingEnabled()
       Whether to send work progress updates to the service.
      bool reporting_enabled = 2;
      Specified by:
      getReportingEnabled in interface WorkerSettingsOrBuilder
      Returns:
      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;
      Specified by:
      getServicePath in interface WorkerSettingsOrBuilder
      Returns:
      The servicePath.

    • getServicePathBytes

      public com.google.protobuf.ByteString getServicePathBytes()
       The Cloud Dataflow service path relative to the root URL, for example,
 "dataflow/v1b3/projects".
      string service_path = 3;
      Specified by:
      getServicePathBytes in interface WorkerSettingsOrBuilder
      Returns:
      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;
      Specified by:
      getShuffleServicePath in interface WorkerSettingsOrBuilder
      Returns:
      The shuffleServicePath.

    • getShuffleServicePathBytes

      public com.google.protobuf.ByteString getShuffleServicePathBytes()
       The Shuffle service path relative to the root URL, for example,
 "shuffle/v1beta1".
      string shuffle_service_path = 4;
      Specified by:
      getShuffleServicePathBytes in interface WorkerSettingsOrBuilder
      Returns:
      The bytes for shuffleServicePath.

    • getWorkerId

      public String getWorkerId()
       The ID of the worker running this pipeline.
      string worker_id = 5;
      Specified by:
      getWorkerId in interface WorkerSettingsOrBuilder
      Returns:
      The workerId.

    • getWorkerIdBytes

      public com.google.protobuf.ByteString getWorkerIdBytes()
       The ID of the worker running this pipeline.
      string worker_id = 5;
      Specified by:
      getWorkerIdBytes in interface WorkerSettingsOrBuilder
      Returns:
      The bytes for workerId.

    • 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;
      Specified by:
      getTempStoragePrefix in interface WorkerSettingsOrBuilder
      Returns:
      The tempStoragePrefix.

    • getTempStoragePrefixBytes

      public com.google.protobuf.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;
      Specified by:
      getTempStoragePrefixBytes in interface WorkerSettingsOrBuilder
      Returns:
      The bytes for tempStoragePrefix.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static WorkerSettings parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkerSettings parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkerSettings parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkerSettings parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkerSettings parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkerSettings parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkerSettings parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WorkerSettings parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static WorkerSettings parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static WorkerSettings parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WorkerSettings parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WorkerSettings parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public WorkerSettings.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static WorkerSettings.Builder newBuilder()

    • newBuilder

      public static WorkerSettings.Builder newBuilder(WorkerSettings prototype)

    • toBuilder

      public WorkerSettings.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected WorkerSettings.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static WorkerSettings getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<WorkerSettings> parser()

    • getParserForType

      public com.google.protobuf.Parser<WorkerSettings> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public WorkerSettings getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder