Class SdkHarnessContainerImage.Builder (0.16.0)

public static final class SdkHarnessContainerImage.Builder extends GeneratedMessageV3.Builder<SdkHarnessContainerImage.Builder> implements SdkHarnessContainerImageOrBuilder

Defines a SDK harness container for executing Dataflow pipelines.

Protobuf type google.dataflow.v1beta3.SdkHarnessContainerImage

Static Methods

getDescriptor()

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

Methods

addAllCapabilities(Iterable<String> values)

public SdkHarnessContainerImage.Builder addAllCapabilities(Iterable<String> values)

The set of capabilities enumerated in the above Environment proto. See also https://github.com/apache/beam/blob/master/model/pipeline/src/main/proto/beam_runner_api.proto

repeated string capabilities = 4;

Parameter
NameDescription
valuesIterable<String>

The capabilities to add.

Returns
TypeDescription
SdkHarnessContainerImage.Builder

This builder for chaining.

addCapabilities(String value)

public SdkHarnessContainerImage.Builder addCapabilities(String value)

The set of capabilities enumerated in the above Environment proto. See also https://github.com/apache/beam/blob/master/model/pipeline/src/main/proto/beam_runner_api.proto

repeated string capabilities = 4;

Parameter
NameDescription
valueString

The capabilities to add.

Returns
TypeDescription
SdkHarnessContainerImage.Builder

This builder for chaining.

addCapabilitiesBytes(ByteString value)

public SdkHarnessContainerImage.Builder addCapabilitiesBytes(ByteString value)

The set of capabilities enumerated in the above Environment proto. See also https://github.com/apache/beam/blob/master/model/pipeline/src/main/proto/beam_runner_api.proto

repeated string capabilities = 4;

Parameter
NameDescription
valueByteString

The bytes of the capabilities to add.

Returns
TypeDescription
SdkHarnessContainerImage.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SdkHarnessContainerImage.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SdkHarnessContainerImage.Builder
Overrides

build()

public SdkHarnessContainerImage build()
Returns
TypeDescription
SdkHarnessContainerImage

buildPartial()

public SdkHarnessContainerImage buildPartial()
Returns
TypeDescription
SdkHarnessContainerImage

clear()

public SdkHarnessContainerImage.Builder clear()
Returns
TypeDescription
SdkHarnessContainerImage.Builder
Overrides

clearCapabilities()

public SdkHarnessContainerImage.Builder clearCapabilities()

The set of capabilities enumerated in the above Environment proto. See also https://github.com/apache/beam/blob/master/model/pipeline/src/main/proto/beam_runner_api.proto

repeated string capabilities = 4;

Returns
TypeDescription
SdkHarnessContainerImage.Builder

This builder for chaining.

clearContainerImage()

public SdkHarnessContainerImage.Builder clearContainerImage()

A docker container image that resides in Google Container Registry.

string container_image = 1;

Returns
TypeDescription
SdkHarnessContainerImage.Builder

This builder for chaining.

clearEnvironmentId()

public SdkHarnessContainerImage.Builder clearEnvironmentId()

Environment ID for the Beam runner API proto Environment that corresponds to the current SDK Harness.

string environment_id = 3;

Returns
TypeDescription
SdkHarnessContainerImage.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SdkHarnessContainerImage.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SdkHarnessContainerImage.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SdkHarnessContainerImage.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SdkHarnessContainerImage.Builder
Overrides

clearUseSingleCorePerContainer()

public SdkHarnessContainerImage.Builder clearUseSingleCorePerContainer()

If true, recommends the Dataflow service to use only one core per SDK container instance with this image. If false (or unset) recommends using more than one core per SDK container instance with this image for efficiency. Note that Dataflow service may choose to override this property if needed.

bool use_single_core_per_container = 2;

Returns
TypeDescription
SdkHarnessContainerImage.Builder

This builder for chaining.

clone()

public SdkHarnessContainerImage.Builder clone()
Returns
TypeDescription
SdkHarnessContainerImage.Builder
Overrides

getCapabilities(int index)

public String getCapabilities(int index)

The set of capabilities enumerated in the above Environment proto. See also https://github.com/apache/beam/blob/master/model/pipeline/src/main/proto/beam_runner_api.proto

repeated string capabilities = 4;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The capabilities at the given index.

getCapabilitiesBytes(int index)

public ByteString getCapabilitiesBytes(int index)

The set of capabilities enumerated in the above Environment proto. See also https://github.com/apache/beam/blob/master/model/pipeline/src/main/proto/beam_runner_api.proto

repeated string capabilities = 4;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the capabilities at the given index.

getCapabilitiesCount()

public int getCapabilitiesCount()

The set of capabilities enumerated in the above Environment proto. See also https://github.com/apache/beam/blob/master/model/pipeline/src/main/proto/beam_runner_api.proto

repeated string capabilities = 4;

Returns
TypeDescription
int

The count of capabilities.

getCapabilitiesList()

public ProtocolStringList getCapabilitiesList()

The set of capabilities enumerated in the above Environment proto. See also https://github.com/apache/beam/blob/master/model/pipeline/src/main/proto/beam_runner_api.proto

repeated string capabilities = 4;

Returns
TypeDescription
ProtocolStringList

A list containing the capabilities.

getContainerImage()

public String getContainerImage()

A docker container image that resides in Google Container Registry.

string container_image = 1;

Returns
TypeDescription
String

The containerImage.

getContainerImageBytes()

public ByteString getContainerImageBytes()

A docker container image that resides in Google Container Registry.

string container_image = 1;

Returns
TypeDescription
ByteString

The bytes for containerImage.

getDefaultInstanceForType()

public SdkHarnessContainerImage getDefaultInstanceForType()
Returns
TypeDescription
SdkHarnessContainerImage

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEnvironmentId()

public String getEnvironmentId()

Environment ID for the Beam runner API proto Environment that corresponds to the current SDK Harness.

string environment_id = 3;

Returns
TypeDescription
String

The environmentId.

getEnvironmentIdBytes()

public ByteString getEnvironmentIdBytes()

Environment ID for the Beam runner API proto Environment that corresponds to the current SDK Harness.

string environment_id = 3;

Returns
TypeDescription
ByteString

The bytes for environmentId.

getUseSingleCorePerContainer()

public boolean getUseSingleCorePerContainer()

If true, recommends the Dataflow service to use only one core per SDK container instance with this image. If false (or unset) recommends using more than one core per SDK container instance with this image for efficiency. Note that Dataflow service may choose to override this property if needed.

bool use_single_core_per_container = 2;

Returns
TypeDescription
boolean

The useSingleCorePerContainer.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SdkHarnessContainerImage other)

public SdkHarnessContainerImage.Builder mergeFrom(SdkHarnessContainerImage other)
Parameter
NameDescription
otherSdkHarnessContainerImage
Returns
TypeDescription
SdkHarnessContainerImage.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SdkHarnessContainerImage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SdkHarnessContainerImage.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SdkHarnessContainerImage.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SdkHarnessContainerImage.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SdkHarnessContainerImage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SdkHarnessContainerImage.Builder
Overrides

setCapabilities(int index, String value)

public SdkHarnessContainerImage.Builder setCapabilities(int index, String value)

The set of capabilities enumerated in the above Environment proto. See also https://github.com/apache/beam/blob/master/model/pipeline/src/main/proto/beam_runner_api.proto

repeated string capabilities = 4;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The capabilities to set.

Returns
TypeDescription
SdkHarnessContainerImage.Builder

This builder for chaining.

setContainerImage(String value)

public SdkHarnessContainerImage.Builder setContainerImage(String value)

A docker container image that resides in Google Container Registry.

string container_image = 1;

Parameter
NameDescription
valueString

The containerImage to set.

Returns
TypeDescription
SdkHarnessContainerImage.Builder

This builder for chaining.

setContainerImageBytes(ByteString value)

public SdkHarnessContainerImage.Builder setContainerImageBytes(ByteString value)

A docker container image that resides in Google Container Registry.

string container_image = 1;

Parameter
NameDescription
valueByteString

The bytes for containerImage to set.

Returns
TypeDescription
SdkHarnessContainerImage.Builder

This builder for chaining.

setEnvironmentId(String value)

public SdkHarnessContainerImage.Builder setEnvironmentId(String value)

Environment ID for the Beam runner API proto Environment that corresponds to the current SDK Harness.

string environment_id = 3;

Parameter
NameDescription
valueString

The environmentId to set.

Returns
TypeDescription
SdkHarnessContainerImage.Builder

This builder for chaining.

setEnvironmentIdBytes(ByteString value)

public SdkHarnessContainerImage.Builder setEnvironmentIdBytes(ByteString value)

Environment ID for the Beam runner API proto Environment that corresponds to the current SDK Harness.

string environment_id = 3;

Parameter
NameDescription
valueByteString

The bytes for environmentId to set.

Returns
TypeDescription
SdkHarnessContainerImage.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SdkHarnessContainerImage.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SdkHarnessContainerImage.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SdkHarnessContainerImage.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SdkHarnessContainerImage.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SdkHarnessContainerImage.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SdkHarnessContainerImage.Builder
Overrides

setUseSingleCorePerContainer(boolean value)

public SdkHarnessContainerImage.Builder setUseSingleCorePerContainer(boolean value)

If true, recommends the Dataflow service to use only one core per SDK container instance with this image. If false (or unset) recommends using more than one core per SDK container instance with this image for efficiency. Note that Dataflow service may choose to override this property if needed.

bool use_single_core_per_container = 2;

Parameter
NameDescription
valueboolean

The useSingleCorePerContainer to set.

Returns
TypeDescription
SdkHarnessContainerImage.Builder

This builder for chaining.