Class SpriteSheet.Builder (0.11.0)

public static final class SpriteSheet.Builder extends GeneratedMessageV3.Builder<SpriteSheet.Builder> implements SpriteSheetOrBuilder

Sprite sheet configuration.

Protobuf type google.cloud.video.livestream.v1.SpriteSheet

Inheritance

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

Implements

SpriteSheetOrBuilder

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)

GeneratedMessageV3.Builder.internalGetMutableMapField(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 SpriteSheet.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns

Type	Description
`SpriteSheet.Builder`

Overrides

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

build()

public SpriteSheet build()

Returns

Type	Description
`SpriteSheet`

buildPartial()

public SpriteSheet buildPartial()

Returns

Type	Description
`SpriteSheet`

clear()

public SpriteSheet.Builder clear()

Returns

Type	Description
`SpriteSheet.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearColumnCount()

public SpriteSheet.Builder clearColumnCount()

The maximum number of sprites per row in a sprite sheet. Valid range is [1, 10] and the default value is 1.

int32 column_count = 5;

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SpriteSheet.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
`field`	`FieldDescriptor`

Returns

Type	Description
`SpriteSheet.Builder`

Overrides

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

clearFilePrefix()

public SpriteSheet.Builder clearFilePrefix()

Required. File name prefix for the generated sprite sheets. If multiple sprite sheets are added to the channel, each must have a unique file prefix. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as sprite_sheet0000000123.jpeg.

string file_prefix = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

clearFormat()

public SpriteSheet.Builder clearFormat()

Format type. The default is jpeg. Supported formats:

jpeg

string format = 1;

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

clearInterval()

public SpriteSheet.Builder clearInterval()

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

.google.protobuf.Duration interval = 7;

Returns

Type	Description
`SpriteSheet.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public SpriteSheet.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
`oneof`	`OneofDescriptor`

Returns

Type	Description
`SpriteSheet.Builder`

Overrides

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

clearQuality()

public SpriteSheet.Builder clearQuality()

The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.

int32 quality = 8;

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

clearRowCount()

public SpriteSheet.Builder clearRowCount()

The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. Valid range is [1, 10] and the default value is 1.

int32 row_count = 6;

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

clearSpriteHeightPixels()

public SpriteSheet.Builder clearSpriteHeightPixels()

Required. The height of the sprite in pixels. Must be an even integer.

int32 sprite_height_pixels = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

clearSpriteWidthPixels()

public SpriteSheet.Builder clearSpriteWidthPixels()

Required. The width of the sprite in pixels. Must be an even integer.

int32 sprite_width_pixels = 3 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

clone()

public SpriteSheet.Builder clone()

Returns

Type	Description
`SpriteSheet.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getColumnCount()

public int getColumnCount()

The maximum number of sprites per row in a sprite sheet. Valid range is [1, 10] and the default value is 1.

int32 column_count = 5;

Returns

Type	Description
`int`	The columnCount.

getDefaultInstanceForType()

public SpriteSheet getDefaultInstanceForType()

Returns

Type	Description
`SpriteSheet`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilePrefix()

public String getFilePrefix()

string file_prefix = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`String`	The filePrefix.

getFilePrefixBytes()

public ByteString getFilePrefixBytes()

string file_prefix = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`ByteString`	The bytes for filePrefix.

getFormat()

public String getFormat()

Format type. The default is jpeg. Supported formats:

jpeg

string format = 1;

Returns

Type	Description
`String`	The format.

getFormatBytes()

public ByteString getFormatBytes()

Format type. The default is jpeg. Supported formats:

jpeg

string format = 1;

Returns

Type	Description
`ByteString`	The bytes for format.

getInterval()

public Duration getInterval()

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

.google.protobuf.Duration interval = 7;

Returns

Type	Description
`Duration`	The interval.

getIntervalBuilder()

public Duration.Builder getIntervalBuilder()

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

.google.protobuf.Duration interval = 7;

Returns

Type	Description
`Builder`

getIntervalOrBuilder()

public DurationOrBuilder getIntervalOrBuilder()

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

.google.protobuf.Duration interval = 7;

Returns

Type	Description
`DurationOrBuilder`

getQuality()

public int getQuality()

int32 quality = 8;

Returns

Type	Description
`int`	The quality.

getRowCount()

public int getRowCount()

The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. Valid range is [1, 10] and the default value is 1.

int32 row_count = 6;

Returns

Type	Description
`int`	The rowCount.

getSpriteHeightPixels()

public int getSpriteHeightPixels()

Required. The height of the sprite in pixels. Must be an even integer.

int32 sprite_height_pixels = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`int`	The spriteHeightPixels.

getSpriteWidthPixels()

public int getSpriteWidthPixels()

Required. The width of the sprite in pixels. Must be an even integer.

int32 sprite_width_pixels = 3 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`int`	The spriteWidthPixels.

hasInterval()

public boolean hasInterval()

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

.google.protobuf.Duration interval = 7;

Returns

Type	Description
`boolean`	Whether the interval field is set.

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(SpriteSheet other)

public SpriteSheet.Builder mergeFrom(SpriteSheet other)

Parameter

Name	Description
`other`	`SpriteSheet`

Returns

Type	Description
`SpriteSheet.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`SpriteSheet.Builder`

Overrides

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

Exceptions

Type	Description
`IOException`

mergeFrom(Message other)

public SpriteSheet.Builder mergeFrom(Message other)

Parameter

Name	Description
`other`	`Message`

Returns

Type	Description
`SpriteSheet.Builder`

Overrides

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

mergeInterval(Duration value)

public SpriteSheet.Builder mergeInterval(Duration value)

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

.google.protobuf.Duration interval = 7;

Parameter

Name	Description
`value`	`Duration`

Returns

Type	Description
`SpriteSheet.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SpriteSheet.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`SpriteSheet.Builder`

Overrides

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

setColumnCount(int value)

public SpriteSheet.Builder setColumnCount(int value)

The maximum number of sprites per row in a sprite sheet. Valid range is [1, 10] and the default value is 1.

int32 column_count = 5;

Parameter

Name	Description
`value`	`int` The columnCount to set.

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns

Type	Description
`SpriteSheet.Builder`

Overrides

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

setFilePrefix(String value)

public SpriteSheet.Builder setFilePrefix(String value)

string file_prefix = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
`value`	`String` The filePrefix to set.

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

setFilePrefixBytes(ByteString value)

public SpriteSheet.Builder setFilePrefixBytes(ByteString value)

string file_prefix = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
`value`	`ByteString` The bytes for filePrefix to set.

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

setFormat(String value)

public SpriteSheet.Builder setFormat(String value)

Format type. The default is jpeg. Supported formats:

jpeg

string format = 1;

Parameter

Name	Description
`value`	`String` The format to set.

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

setFormatBytes(ByteString value)

public SpriteSheet.Builder setFormatBytes(ByteString value)

Format type. The default is jpeg. Supported formats:

jpeg

string format = 1;

Parameter

Name	Description
`value`	`ByteString` The bytes for format to set.

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

setInterval(Duration value)

public SpriteSheet.Builder setInterval(Duration value)

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

.google.protobuf.Duration interval = 7;

Parameter

Name	Description
`value`	`Duration`

Returns

Type	Description
`SpriteSheet.Builder`

setInterval(Duration.Builder builderForValue)

public SpriteSheet.Builder setInterval(Duration.Builder builderForValue)

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

.google.protobuf.Duration interval = 7;

Parameter

Name	Description
`builderForValue`	`Builder`

Returns

Type	Description
`SpriteSheet.Builder`

setQuality(int value)

public SpriteSheet.Builder setQuality(int value)

int32 quality = 8;

Parameter

Name	Description
`value`	`int` The quality to set.

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

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

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

Parameters

Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns

Type	Description
`SpriteSheet.Builder`

Overrides

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

setRowCount(int value)

public SpriteSheet.Builder setRowCount(int value)

The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. Valid range is [1, 10] and the default value is 1.

int32 row_count = 6;

Parameter

Name	Description
`value`	`int` The rowCount to set.

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

setSpriteHeightPixels(int value)

public SpriteSheet.Builder setSpriteHeightPixels(int value)

Required. The height of the sprite in pixels. Must be an even integer.

int32 sprite_height_pixels = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
`value`	`int` The spriteHeightPixels to set.

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

setSpriteWidthPixels(int value)

public SpriteSheet.Builder setSpriteWidthPixels(int value)

Required. The width of the sprite in pixels. Must be an even integer.

int32 sprite_width_pixels = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
`value`	`int` The spriteWidthPixels to set.

Returns

Type	Description
`SpriteSheet.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SpriteSheet.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`SpriteSheet.Builder`

Overrides

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