Class ResourceSpecification.Builder (0.2.0)

Version latest

• 0.2.0 (latest)
• 0.1.0

public static final class ResourceSpecification.Builder extends GeneratedMessageV3.Builder<ResourceSpecification.Builder> implements ResourceSpecificationOrBuilder

ResourceSpec collects a set of resources that can be used to specify requests and requirements.

Note: Highly experimental as this can be runtime dependent. Can use the "extras" field to experiment first before trying to abstract it.

Protobuf type google.cloud.visionai.v1.ResourceSpecification

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ResourceSpecification.Builder

Implements

ResourceSpecificationOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ResourceSpecification.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ResourceSpecification.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ResourceSpecification build()

Returns
Type	Description
ResourceSpecification

buildPartial()

public ResourceSpecification buildPartial()

Returns
Type	Description
ResourceSpecification

clear()

public ResourceSpecification.Builder clear()

Returns
Type	Description
ResourceSpecification.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCpu()

public ResourceSpecification.Builder clearCpu()

CPU specification.

Examples: "100m", "0.5", "1", "2", ... correspond to 0.1, half, 1, or 2 cpus.

Leave empty to let the system decide.

Note that this does not determine the cpu vender/make, or its underlying clock speed and specific SIMD features. It is only the amount time it requires in timeslicing.

string cpu = 1;

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

clearCpuLimits()

public ResourceSpecification.Builder clearCpuLimits()

CPU limit.

Examples: "100m", "0.5", "1", "2", ... correspond to 0.1, half, 1, or 2 cpus.

Leave empty to indicate no limit.

string cpu_limits = 5;

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ResourceSpecification.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ResourceSpecification.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGpus()

public ResourceSpecification.Builder clearGpus()

Number of gpus.

int32 gpus = 3;

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

clearLatencyBudgetMs()

public ResourceSpecification.Builder clearLatencyBudgetMs()

The maximum latency that this operator may use to process an element.

If non positive, then a system default will be used. Operator developers should arrange for the system compute resources to be aligned with this latency budget; e.g. if you want a ML model to produce results within 500ms, then you should make sure you request enough cpu/gpu/memory to achieve that.

int32 latency_budget_ms = 4;

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

clearMemory()

public ResourceSpecification.Builder clearMemory()

Memory specification (in bytes).

Examples: "128974848", "129e6", "129M", "123Mi", ... correspond to 128974848 bytes, 129000000 bytes, 129 mebibytes, 123 megabytes.

Leave empty to let the system decide.

string memory = 2;

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

clearMemoryLimits()

public ResourceSpecification.Builder clearMemoryLimits()

Memory usage limits.

Examples: "128974848", "129e6", "129M", "123Mi", ... correspond to 128974848 bytes, 129000000 bytes, 129 mebibytes, 123 megabytes.

Leave empty to indicate no limit.

string memory_limits = 6;

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ResourceSpecification.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
ResourceSpecification.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public ResourceSpecification.Builder clone()

Returns
Type	Description
ResourceSpecification.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCpu()

public String getCpu()

CPU specification.

Examples: "100m", "0.5", "1", "2", ... correspond to 0.1, half, 1, or 2 cpus.

Leave empty to let the system decide.

Note that this does not determine the cpu vender/make, or its underlying clock speed and specific SIMD features. It is only the amount time it requires in timeslicing.

string cpu = 1;

Returns
Type	Description
String	The cpu.

getCpuBytes()

public ByteString getCpuBytes()

CPU specification.

Examples: "100m", "0.5", "1", "2", ... correspond to 0.1, half, 1, or 2 cpus.

Leave empty to let the system decide.

Note that this does not determine the cpu vender/make, or its underlying clock speed and specific SIMD features. It is only the amount time it requires in timeslicing.

string cpu = 1;

Returns
Type	Description
ByteString	The bytes for cpu.

getCpuLimits()

public String getCpuLimits()

CPU limit.

Examples: "100m", "0.5", "1", "2", ... correspond to 0.1, half, 1, or 2 cpus.

Leave empty to indicate no limit.

string cpu_limits = 5;

Returns
Type	Description
String	The cpuLimits.

getCpuLimitsBytes()

public ByteString getCpuLimitsBytes()

CPU limit.

Examples: "100m", "0.5", "1", "2", ... correspond to 0.1, half, 1, or 2 cpus.

Leave empty to indicate no limit.

string cpu_limits = 5;

Returns
Type	Description
ByteString	The bytes for cpuLimits.

getDefaultInstanceForType()

public ResourceSpecification getDefaultInstanceForType()

Returns
Type	Description
ResourceSpecification

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getGpus()

public int getGpus()

Number of gpus.

int32 gpus = 3;

Returns
Type	Description
int	The gpus.

getLatencyBudgetMs()

public int getLatencyBudgetMs()

The maximum latency that this operator may use to process an element.

If non positive, then a system default will be used. Operator developers should arrange for the system compute resources to be aligned with this latency budget; e.g. if you want a ML model to produce results within 500ms, then you should make sure you request enough cpu/gpu/memory to achieve that.

int32 latency_budget_ms = 4;

Returns
Type	Description
int	The latencyBudgetMs.

getMemory()

public String getMemory()

Memory specification (in bytes).

Examples: "128974848", "129e6", "129M", "123Mi", ... correspond to 128974848 bytes, 129000000 bytes, 129 mebibytes, 123 megabytes.

Leave empty to let the system decide.

string memory = 2;

Returns
Type	Description
String	The memory.

getMemoryBytes()

public ByteString getMemoryBytes()

Memory specification (in bytes).

Examples: "128974848", "129e6", "129M", "123Mi", ... correspond to 128974848 bytes, 129000000 bytes, 129 mebibytes, 123 megabytes.

Leave empty to let the system decide.

string memory = 2;

Returns
Type	Description
ByteString	The bytes for memory.

getMemoryLimits()

public String getMemoryLimits()

Memory usage limits.

Examples: "128974848", "129e6", "129M", "123Mi", ... correspond to 128974848 bytes, 129000000 bytes, 129 mebibytes, 123 megabytes.

Leave empty to indicate no limit.

string memory_limits = 6;

Returns
Type	Description
String	The memoryLimits.

getMemoryLimitsBytes()

public ByteString getMemoryLimitsBytes()

Memory usage limits.

Examples: "128974848", "129e6", "129M", "123Mi", ... correspond to 128974848 bytes, 129000000 bytes, 129 mebibytes, 123 megabytes.

Leave empty to indicate no limit.

string memory_limits = 6;

Returns
Type	Description
ByteString	The bytes for memoryLimits.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ResourceSpecification other)

public ResourceSpecification.Builder mergeFrom(ResourceSpecification other)

Parameter
Name	Description
other	ResourceSpecification

Returns
Type	Description
ResourceSpecification.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ResourceSpecification.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ResourceSpecification.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ResourceSpecification.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ResourceSpecification.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ResourceSpecification.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ResourceSpecification.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setCpu(String value)

public ResourceSpecification.Builder setCpu(String value)

CPU specification.

Examples: "100m", "0.5", "1", "2", ... correspond to 0.1, half, 1, or 2 cpus.

Leave empty to let the system decide.

Note that this does not determine the cpu vender/make, or its underlying clock speed and specific SIMD features. It is only the amount time it requires in timeslicing.

string cpu = 1;

Parameter
Name	Description
value	String The cpu to set.

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

setCpuBytes(ByteString value)

public ResourceSpecification.Builder setCpuBytes(ByteString value)

CPU specification.

Examples: "100m", "0.5", "1", "2", ... correspond to 0.1, half, 1, or 2 cpus.

Leave empty to let the system decide.

Note that this does not determine the cpu vender/make, or its underlying clock speed and specific SIMD features. It is only the amount time it requires in timeslicing.

string cpu = 1;

Parameter
Name	Description
value	ByteString The bytes for cpu to set.

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

setCpuLimits(String value)

public ResourceSpecification.Builder setCpuLimits(String value)

CPU limit.

Examples: "100m", "0.5", "1", "2", ... correspond to 0.1, half, 1, or 2 cpus.

Leave empty to indicate no limit.

string cpu_limits = 5;

Parameter
Name	Description
value	String The cpuLimits to set.

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

setCpuLimitsBytes(ByteString value)

public ResourceSpecification.Builder setCpuLimitsBytes(ByteString value)

CPU limit.

Examples: "100m", "0.5", "1", "2", ... correspond to 0.1, half, 1, or 2 cpus.

Leave empty to indicate no limit.

string cpu_limits = 5;

Parameter
Name	Description
value	ByteString The bytes for cpuLimits to set.

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ResourceSpecification.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ResourceSpecification.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGpus(int value)

public ResourceSpecification.Builder setGpus(int value)

Number of gpus.

int32 gpus = 3;

Parameter
Name	Description
value	int The gpus to set.

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

setLatencyBudgetMs(int value)

public ResourceSpecification.Builder setLatencyBudgetMs(int value)

The maximum latency that this operator may use to process an element.

If non positive, then a system default will be used. Operator developers should arrange for the system compute resources to be aligned with this latency budget; e.g. if you want a ML model to produce results within 500ms, then you should make sure you request enough cpu/gpu/memory to achieve that.

int32 latency_budget_ms = 4;

Parameter
Name	Description
value	int The latencyBudgetMs to set.

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

setMemory(String value)

public ResourceSpecification.Builder setMemory(String value)

Memory specification (in bytes).

Examples: "128974848", "129e6", "129M", "123Mi", ... correspond to 128974848 bytes, 129000000 bytes, 129 mebibytes, 123 megabytes.

Leave empty to let the system decide.

string memory = 2;

Parameter
Name	Description
value	String The memory to set.

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

setMemoryBytes(ByteString value)

public ResourceSpecification.Builder setMemoryBytes(ByteString value)

Memory specification (in bytes).

Examples: "128974848", "129e6", "129M", "123Mi", ... correspond to 128974848 bytes, 129000000 bytes, 129 mebibytes, 123 megabytes.

Leave empty to let the system decide.

string memory = 2;

Parameter
Name	Description
value	ByteString The bytes for memory to set.

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

setMemoryLimits(String value)

public ResourceSpecification.Builder setMemoryLimits(String value)

Memory usage limits.

Examples: "128974848", "129e6", "129M", "123Mi", ... correspond to 128974848 bytes, 129000000 bytes, 129 mebibytes, 123 megabytes.

Leave empty to indicate no limit.

string memory_limits = 6;

Parameter
Name	Description
value	String The memoryLimits to set.

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

setMemoryLimitsBytes(ByteString value)

public ResourceSpecification.Builder setMemoryLimitsBytes(ByteString value)

Memory usage limits.

Examples: "128974848", "129e6", "129M", "123Mi", ... correspond to 128974848 bytes, 129000000 bytes, 129 mebibytes, 123 megabytes.

Leave empty to indicate no limit.

string memory_limits = 6;

Parameter
Name	Description
value	ByteString The bytes for memoryLimits to set.

Returns
Type	Description
ResourceSpecification.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
ResourceSpecification.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ResourceSpecification.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ResourceSpecification.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)