Class WorkerSettings.Builder

  • All Implemented Interfaces:
    WorkerSettingsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    WorkerSettings

    public static final class WorkerSettings.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<WorkerSettings.Builder>
    implements WorkerSettingsOrBuilder
     Provides data to pass through to the worker harness.
     
    Protobuf type google.dataflow.v1beta3.WorkerSettings
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<WorkerSettings.Builder>
      • clear

        public WorkerSettings.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<WorkerSettings.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<WorkerSettings.Builder>
      • getDefaultInstanceForType

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

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

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

        public WorkerSettings.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<WorkerSettings.Builder>
      • setField

        public WorkerSettings.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<WorkerSettings.Builder>
      • clearField

        public WorkerSettings.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<WorkerSettings.Builder>
      • clearOneof

        public WorkerSettings.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<WorkerSettings.Builder>
      • setRepeatedField

        public WorkerSettings.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       int index,
                                                       Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<WorkerSettings.Builder>
      • addRepeatedField

        public WorkerSettings.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<WorkerSettings.Builder>
      • mergeFrom

        public WorkerSettings.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<WorkerSettings.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<WorkerSettings.Builder>
      • mergeFrom

        public WorkerSettings.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<WorkerSettings.Builder>
        Throws:
        IOException
      • 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.
      • setBaseUrl

        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;
        Parameters:
        value - The baseUrl to set.
        Returns:
        This builder for chaining.
      • 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:
        This builder for chaining.
      • setBaseUrlBytes

        public WorkerSettings.Builder setBaseUrlBytes​(com.google.protobuf.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;
        Parameters:
        value - The bytes for baseUrl to set.
        Returns:
        This builder for chaining.
      • 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.
      • setReportingEnabled

        public WorkerSettings.Builder setReportingEnabled​(boolean value)
         Whether to send work progress updates to the service.
         
        bool reporting_enabled = 2;
        Parameters:
        value - The reportingEnabled to set.
        Returns:
        This builder for chaining.
      • clearReportingEnabled

        public WorkerSettings.Builder clearReportingEnabled()
         Whether to send work progress updates to the service.
         
        bool reporting_enabled = 2;
        Returns:
        This builder for chaining.
      • 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.
      • setServicePath

        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;
        Parameters:
        value - The servicePath to set.
        Returns:
        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:
        This builder for chaining.
      • setServicePathBytes

        public WorkerSettings.Builder setServicePathBytes​(com.google.protobuf.ByteString value)
         The Cloud Dataflow service path relative to the root URL, for example,
         "dataflow/v1b3/projects".
         
        string service_path = 3;
        Parameters:
        value - The bytes for servicePath to set.
        Returns:
        This builder for chaining.
      • 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.
      • setShuffleServicePath

        public WorkerSettings.Builder setShuffleServicePath​(String value)
         The Shuffle service path relative to the root URL, for example,
         "shuffle/v1beta1".
         
        string shuffle_service_path = 4;
        Parameters:
        value - The shuffleServicePath to set.
        Returns:
        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:
        This builder for chaining.
      • setShuffleServicePathBytes

        public WorkerSettings.Builder setShuffleServicePathBytes​(com.google.protobuf.ByteString value)
         The Shuffle service path relative to the root URL, for example,
         "shuffle/v1beta1".
         
        string shuffle_service_path = 4;
        Parameters:
        value - The bytes for shuffleServicePath to set.
        Returns:
        This builder for chaining.
      • 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.
      • setWorkerId

        public WorkerSettings.Builder setWorkerId​(String value)
         The ID of the worker running this pipeline.
         
        string worker_id = 5;
        Parameters:
        value - The workerId to set.
        Returns:
        This builder for chaining.
      • clearWorkerId

        public WorkerSettings.Builder clearWorkerId()
         The ID of the worker running this pipeline.
         
        string worker_id = 5;
        Returns:
        This builder for chaining.
      • setWorkerIdBytes

        public WorkerSettings.Builder setWorkerIdBytes​(com.google.protobuf.ByteString value)
         The ID of the worker running this pipeline.
         
        string worker_id = 5;
        Parameters:
        value - The bytes for workerId to set.
        Returns:
        This builder for chaining.
      • 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.
      • setTempStoragePrefix

        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;
        Parameters:
        value - The tempStoragePrefix to set.
        Returns:
        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:
        This builder for chaining.
      • setTempStoragePrefixBytes

        public WorkerSettings.Builder setTempStoragePrefixBytes​(com.google.protobuf.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;
        Parameters:
        value - The bytes for tempStoragePrefix to set.
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final WorkerSettings.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<WorkerSettings.Builder>
      • mergeUnknownFields

        public final WorkerSettings.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<WorkerSettings.Builder>