Package com.google.dataflow.v1beta3

Interface WorkerPoolOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    WorkerPool, WorkerPool.Builder
    public interface WorkerPoolOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getKind

        String getKind()
         The kind of the worker pool; currently only `harness` and `shuffle`
 are supported.
        string kind = 1;
        Returns:
        The kind.

      • getKindBytes

        com.google.protobuf.ByteString getKindBytes()
         The kind of the worker pool; currently only `harness` and `shuffle`
 are supported.
        string kind = 1;
        Returns:
        The bytes for kind.

      • getNumWorkers

        int getNumWorkers()
         Number of Google Compute Engine workers in this pool needed to
 execute the job.  If zero or unspecified, the service will
 attempt to choose a reasonable default.
        int32 num_workers = 2;
        Returns:
        The numWorkers.

      • getPackagesList

        List<Package> getPackagesList()
         Packages to be installed on workers.
        repeated .google.dataflow.v1beta3.Package packages = 3;

      • getPackages

        Package getPackages​(int index)
         Packages to be installed on workers.
        repeated .google.dataflow.v1beta3.Package packages = 3;

      • getPackagesCount

        int getPackagesCount()
         Packages to be installed on workers.
        repeated .google.dataflow.v1beta3.Package packages = 3;

      • getPackagesOrBuilderList

        List<? extends PackageOrBuilder> getPackagesOrBuilderList()
         Packages to be installed on workers.
        repeated .google.dataflow.v1beta3.Package packages = 3;

      • getPackagesOrBuilder

        PackageOrBuilder getPackagesOrBuilder​(int index)
         Packages to be installed on workers.
        repeated .google.dataflow.v1beta3.Package packages = 3;

      • getDefaultPackageSetValue

        int getDefaultPackageSetValue()
         The default package set to install.  This allows the service to
 select a default set of packages which are useful to worker
 harnesses written in a particular language.
        .google.dataflow.v1beta3.DefaultPackageSet default_package_set = 4;
        Returns:
        The enum numeric value on the wire for defaultPackageSet.

      • getDefaultPackageSet

        DefaultPackageSet getDefaultPackageSet()
         The default package set to install.  This allows the service to
 select a default set of packages which are useful to worker
 harnesses written in a particular language.
        .google.dataflow.v1beta3.DefaultPackageSet default_package_set = 4;
        Returns:
        The defaultPackageSet.

      • getMachineType

        String getMachineType()
         Machine type (e.g. "n1-standard-1").  If empty or unspecified, the
 service will attempt to choose a reasonable default.
        string machine_type = 5;
        Returns:
        The machineType.

      • getMachineTypeBytes

        com.google.protobuf.ByteString getMachineTypeBytes()
         Machine type (e.g. "n1-standard-1").  If empty or unspecified, the
 service will attempt to choose a reasonable default.
        string machine_type = 5;
        Returns:
        The bytes for machineType.

      • getTeardownPolicyValue

        int getTeardownPolicyValue()
         Sets the policy for determining when to turndown worker pool.
 Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
 `TEARDOWN_NEVER`.
 `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
 the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
 if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
 down.

 If the workers are not torn down by the service, they will
 continue to run and use Google Compute Engine VM resources in the
 user's project until they are explicitly terminated by the user.
 Because of this, Google recommends using the `TEARDOWN_ALWAYS`
 policy except for small, manually supervised test jobs.

 If unknown or unspecified, the service will attempt to choose a reasonable
 default.
        .google.dataflow.v1beta3.TeardownPolicy teardown_policy = 6;
        Returns:
        The enum numeric value on the wire for teardownPolicy.

      • getTeardownPolicy

        TeardownPolicy getTeardownPolicy()
         Sets the policy for determining when to turndown worker pool.
 Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
 `TEARDOWN_NEVER`.
 `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
 the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
 if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
 down.

 If the workers are not torn down by the service, they will
 continue to run and use Google Compute Engine VM resources in the
 user's project until they are explicitly terminated by the user.
 Because of this, Google recommends using the `TEARDOWN_ALWAYS`
 policy except for small, manually supervised test jobs.

 If unknown or unspecified, the service will attempt to choose a reasonable
 default.
        .google.dataflow.v1beta3.TeardownPolicy teardown_policy = 6;
        Returns:
        The teardownPolicy.

      • getDiskSizeGb

        int getDiskSizeGb()
         Size of root disk for VMs, in GB.  If zero or unspecified, the service will
 attempt to choose a reasonable default.
        int32 disk_size_gb = 7;
        Returns:
        The diskSizeGb.

      • getDiskType

        String getDiskType()
         Type of root disk for VMs.  If empty or unspecified, the service will
 attempt to choose a reasonable default.
        string disk_type = 16;
        Returns:
        The diskType.

      • getDiskTypeBytes

        com.google.protobuf.ByteString getDiskTypeBytes()
         Type of root disk for VMs.  If empty or unspecified, the service will
 attempt to choose a reasonable default.
        string disk_type = 16;
        Returns:
        The bytes for diskType.

      • getDiskSourceImage

        String getDiskSourceImage()
         Fully qualified source image for disks.
        string disk_source_image = 8;
        Returns:
        The diskSourceImage.

      • getDiskSourceImageBytes

        com.google.protobuf.ByteString getDiskSourceImageBytes()
         Fully qualified source image for disks.
        string disk_source_image = 8;
        Returns:
        The bytes for diskSourceImage.

      • getZone

        String getZone()
         Zone to run the worker pools in.  If empty or unspecified, the service
 will attempt to choose a reasonable default.
        string zone = 9;
        Returns:
        The zone.

      • getZoneBytes

        com.google.protobuf.ByteString getZoneBytes()
         Zone to run the worker pools in.  If empty or unspecified, the service
 will attempt to choose a reasonable default.
        string zone = 9;
        Returns:
        The bytes for zone.

      • hasTaskrunnerSettings

        boolean hasTaskrunnerSettings()
         Settings passed through to Google Compute Engine workers when
 using the standard Dataflow task runner.  Users should ignore
 this field.
        .google.dataflow.v1beta3.TaskRunnerSettings taskrunner_settings = 10;
        Returns:
        Whether the taskrunnerSettings field is set.

      • getTaskrunnerSettings

        TaskRunnerSettings getTaskrunnerSettings()
         Settings passed through to Google Compute Engine workers when
 using the standard Dataflow task runner.  Users should ignore
 this field.
        .google.dataflow.v1beta3.TaskRunnerSettings taskrunner_settings = 10;
        Returns:
        The taskrunnerSettings.

      • getTaskrunnerSettingsOrBuilder

        TaskRunnerSettingsOrBuilder getTaskrunnerSettingsOrBuilder()
         Settings passed through to Google Compute Engine workers when
 using the standard Dataflow task runner.  Users should ignore
 this field.
        .google.dataflow.v1beta3.TaskRunnerSettings taskrunner_settings = 10;

      • getOnHostMaintenance

        String getOnHostMaintenance()
         The action to take on host maintenance, as defined by the Google
 Compute Engine API.
        string on_host_maintenance = 11;
        Returns:
        The onHostMaintenance.

      • getOnHostMaintenanceBytes

        com.google.protobuf.ByteString getOnHostMaintenanceBytes()
         The action to take on host maintenance, as defined by the Google
 Compute Engine API.
        string on_host_maintenance = 11;
        Returns:
        The bytes for onHostMaintenance.

      • getDataDisksList

        List<Disk> getDataDisksList()
         Data disks that are used by a VM in this workflow.
        repeated .google.dataflow.v1beta3.Disk data_disks = 12;

      • getDataDisks

        Disk getDataDisks​(int index)
         Data disks that are used by a VM in this workflow.
        repeated .google.dataflow.v1beta3.Disk data_disks = 12;

      • getDataDisksCount

        int getDataDisksCount()
         Data disks that are used by a VM in this workflow.
        repeated .google.dataflow.v1beta3.Disk data_disks = 12;

      • getDataDisksOrBuilderList

        List<? extends DiskOrBuilder> getDataDisksOrBuilderList()
         Data disks that are used by a VM in this workflow.
        repeated .google.dataflow.v1beta3.Disk data_disks = 12;

      • getDataDisksOrBuilder

        DiskOrBuilder getDataDisksOrBuilder​(int index)
         Data disks that are used by a VM in this workflow.
        repeated .google.dataflow.v1beta3.Disk data_disks = 12;

      • getMetadataCount

        int getMetadataCount()
         Metadata to set on the Google Compute Engine VMs.
        map<string, string> metadata = 13;

      • containsMetadata

        boolean containsMetadata​(String key)
         Metadata to set on the Google Compute Engine VMs.
        map<string, string> metadata = 13;

      • getMetadataMap

        Map<String,​String> getMetadataMap()
         Metadata to set on the Google Compute Engine VMs.
        map<string, string> metadata = 13;

      • getMetadataOrDefault

        String getMetadataOrDefault​(String key,
                            String defaultValue)
         Metadata to set on the Google Compute Engine VMs.
        map<string, string> metadata = 13;

      • getMetadataOrThrow

        String getMetadataOrThrow​(String key)
         Metadata to set on the Google Compute Engine VMs.
        map<string, string> metadata = 13;

      • hasAutoscalingSettings

        boolean hasAutoscalingSettings()
         Settings for autoscaling of this WorkerPool.
        .google.dataflow.v1beta3.AutoscalingSettings autoscaling_settings = 14;
        Returns:
        Whether the autoscalingSettings field is set.

      • getAutoscalingSettings

        AutoscalingSettings getAutoscalingSettings()
         Settings for autoscaling of this WorkerPool.
        .google.dataflow.v1beta3.AutoscalingSettings autoscaling_settings = 14;
        Returns:
        The autoscalingSettings.

      • getAutoscalingSettingsOrBuilder

        AutoscalingSettingsOrBuilder getAutoscalingSettingsOrBuilder()
         Settings for autoscaling of this WorkerPool.
        .google.dataflow.v1beta3.AutoscalingSettings autoscaling_settings = 14;

      • hasPoolArgs

        boolean hasPoolArgs()
         Extra arguments for this worker pool.
        .google.protobuf.Any pool_args = 15;
        Returns:
        Whether the poolArgs field is set.

      • getPoolArgs

        com.google.protobuf.Any getPoolArgs()
         Extra arguments for this worker pool.
        .google.protobuf.Any pool_args = 15;
        Returns:
        The poolArgs.

      • getPoolArgsOrBuilder

        com.google.protobuf.AnyOrBuilder getPoolArgsOrBuilder()
         Extra arguments for this worker pool.
        .google.protobuf.Any pool_args = 15;

      • getNetwork

        String getNetwork()
         Network to which VMs will be assigned.  If empty or unspecified,
 the service will use the network "default".
        string network = 17;
        Returns:
        The network.

      • getNetworkBytes

        com.google.protobuf.ByteString getNetworkBytes()
         Network to which VMs will be assigned.  If empty or unspecified,
 the service will use the network "default".
        string network = 17;
        Returns:
        The bytes for network.

      • getSubnetwork

        String getSubnetwork()
         Subnetwork to which VMs will be assigned, if desired.  Expected to be of
 the form "regions/REGION/subnetworks/SUBNETWORK".
        string subnetwork = 19;
        Returns:
        The subnetwork.

      • getSubnetworkBytes

        com.google.protobuf.ByteString getSubnetworkBytes()
         Subnetwork to which VMs will be assigned, if desired.  Expected to be of
 the form "regions/REGION/subnetworks/SUBNETWORK".
        string subnetwork = 19;
        Returns:
        The bytes for subnetwork.

      • getWorkerHarnessContainerImage

        String getWorkerHarnessContainerImage()
         Required. Docker container image that executes the Cloud Dataflow worker
 harness, residing in Google Container Registry.

 Deprecated for the Fn API path. Use sdk_harness_container_images instead.
        string worker_harness_container_image = 18;
        Returns:
        The workerHarnessContainerImage.

      • getWorkerHarnessContainerImageBytes

        com.google.protobuf.ByteString getWorkerHarnessContainerImageBytes()
         Required. Docker container image that executes the Cloud Dataflow worker
 harness, residing in Google Container Registry.

 Deprecated for the Fn API path. Use sdk_harness_container_images instead.
        string worker_harness_container_image = 18;
        Returns:
        The bytes for workerHarnessContainerImage.

      • getNumThreadsPerWorker

        int getNumThreadsPerWorker()
         The number of threads per worker harness. If empty or unspecified, the
 service will choose a number of threads (according to the number of cores
 on the selected machine type for batch, or 1 by convention for streaming).
        int32 num_threads_per_worker = 20;
        Returns:
        The numThreadsPerWorker.

      • getIpConfigurationValue

        int getIpConfigurationValue()
         Configuration for VM IPs.
        .google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 21;
        Returns:
        The enum numeric value on the wire for ipConfiguration.

      • getIpConfiguration

        WorkerIPAddressConfiguration getIpConfiguration()
         Configuration for VM IPs.
        .google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 21;
        Returns:
        The ipConfiguration.

      • getSdkHarnessContainerImagesList

        List<SdkHarnessContainerImage> getSdkHarnessContainerImagesList()
         Set of SDK harness containers needed to execute this pipeline. This will
 only be set in the Fn API path. For non-cross-language pipelines this
 should have only one entry. Cross-language pipelines will have two or more
 entries.
        repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

      • getSdkHarnessContainerImages

        SdkHarnessContainerImage getSdkHarnessContainerImages​(int index)
         Set of SDK harness containers needed to execute this pipeline. This will
 only be set in the Fn API path. For non-cross-language pipelines this
 should have only one entry. Cross-language pipelines will have two or more
 entries.
        repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

      • getSdkHarnessContainerImagesCount

        int getSdkHarnessContainerImagesCount()
         Set of SDK harness containers needed to execute this pipeline. This will
 only be set in the Fn API path. For non-cross-language pipelines this
 should have only one entry. Cross-language pipelines will have two or more
 entries.
        repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

      • getSdkHarnessContainerImagesOrBuilderList

        List<? extends SdkHarnessContainerImageOrBuilder> getSdkHarnessContainerImagesOrBuilderList()
         Set of SDK harness containers needed to execute this pipeline. This will
 only be set in the Fn API path. For non-cross-language pipelines this
 should have only one entry. Cross-language pipelines will have two or more
 entries.
        repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

      • getSdkHarnessContainerImagesOrBuilder

        SdkHarnessContainerImageOrBuilder getSdkHarnessContainerImagesOrBuilder​(int index)
         Set of SDK harness containers needed to execute this pipeline. This will
 only be set in the Fn API path. For non-cross-language pipelines this
 should have only one entry. Cross-language pipelines will have two or more
 entries.
        repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;