Class SdkHarnessContainerImage

Stay organized with collections Save and categorize content based on your preferences.
public final class SdkHarnessContainerImage extends GeneratedMessageV3 implements SdkHarnessContainerImageOrBuilder

Defines a SDK harness container for executing Dataflow pipelines.

Protobuf type google.dataflow.v1beta3.SdkHarnessContainerImage

Static Fields

CAPABILITIES_FIELD_NUMBER

public static final int CAPABILITIES_FIELD_NUMBER
Field Value
TypeDescription
int

CONTAINER_IMAGE_FIELD_NUMBER

public static final int CONTAINER_IMAGE_FIELD_NUMBER
Field Value
TypeDescription
int

ENVIRONMENT_ID_FIELD_NUMBER

public static final int ENVIRONMENT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

USE_SINGLE_CORE_PER_CONTAINER_FIELD_NUMBER

public static final int USE_SINGLE_CORE_PER_CONTAINER_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SdkHarnessContainerImage getDefaultInstance()
Returns
TypeDescription
SdkHarnessContainerImage

getDescriptor()

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

newBuilder()

public static SdkHarnessContainerImage.Builder newBuilder()
Returns
TypeDescription
SdkHarnessContainerImage.Builder

newBuilder(SdkHarnessContainerImage prototype)

public static SdkHarnessContainerImage.Builder newBuilder(SdkHarnessContainerImage prototype)
Parameter
NameDescription
prototypeSdkHarnessContainerImage
Returns
TypeDescription
SdkHarnessContainerImage.Builder

parseDelimitedFrom(InputStream input)

public static SdkHarnessContainerImage parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SdkHarnessContainerImage
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SdkHarnessContainerImage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SdkHarnessContainerImage
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SdkHarnessContainerImage parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SdkHarnessContainerImage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SdkHarnessContainerImage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SdkHarnessContainerImage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SdkHarnessContainerImage parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SdkHarnessContainerImage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SdkHarnessContainerImage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SdkHarnessContainerImage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SdkHarnessContainerImage parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SdkHarnessContainerImage
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SdkHarnessContainerImage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SdkHarnessContainerImage
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SdkHarnessContainerImage parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SdkHarnessContainerImage
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SdkHarnessContainerImage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SdkHarnessContainerImage
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SdkHarnessContainerImage parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SdkHarnessContainerImage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SdkHarnessContainerImage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SdkHarnessContainerImage
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SdkHarnessContainerImage> parser()
Returns
TypeDescription
Parser<SdkHarnessContainerImage>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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

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.

getParserForType()

public Parser<SdkHarnessContainerImage> getParserForType()
Returns
TypeDescription
Parser<SdkHarnessContainerImage>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SdkHarnessContainerImage.Builder newBuilderForType()
Returns
TypeDescription
SdkHarnessContainerImage.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SdkHarnessContainerImage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SdkHarnessContainerImage.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SdkHarnessContainerImage.Builder toBuilder()
Returns
TypeDescription
SdkHarnessContainerImage.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException