Class FileView (0.66.0)

public final class FileView extends GeneratedMessageV3 implements FileViewOrBuilder

Represents a specific alternate version or "view" of a file object, such as a summary, a thumbnail, a translated version, etc.

Protobuf type google.cloud.discoveryengine.v1alpha.FileView

Implements

FileViewOrBuilder

Static Fields

BYTE_SIZE_FIELD_NUMBER

public static final int BYTE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

FILE_CHARACTERISTICS_FIELD_NUMBER

public static final int FILE_CHARACTERISTICS_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_CHARACTERISTICS_FIELD_NUMBER

public static final int IMAGE_CHARACTERISTICS_FIELD_NUMBER
Field Value
Type Description
int

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

VIDEO_CHARACTERISTICS_FIELD_NUMBER

public static final int VIDEO_CHARACTERISTICS_FIELD_NUMBER
Field Value
Type Description
int

VIEW_ID_FIELD_NUMBER

public static final int VIEW_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FileView getDefaultInstance()
Returns
Type Description
FileView

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FileView.Builder newBuilder()
Returns
Type Description
FileView.Builder

newBuilder(FileView prototype)

public static FileView.Builder newBuilder(FileView prototype)
Parameter
Name Description
prototype FileView
Returns
Type Description
FileView.Builder

parseDelimitedFrom(InputStream input)

public static FileView parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FileView
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FileView parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FileView
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FileView parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FileView
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FileView parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FileView
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FileView parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FileView
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FileView parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FileView
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FileView parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FileView
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FileView parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FileView
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FileView parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FileView
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FileView parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FileView
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FileView parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FileView
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FileView parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FileView
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FileView> parser()
Returns
Type Description
Parser<FileView>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getByteSize()

public long getByteSize()

Output only. The size of the view in bytes.

int64 byte_size = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The byteSize.

getCharacteristicsCase()

public FileView.CharacteristicsCase getCharacteristicsCase()
Returns
Type Description
FileView.CharacteristicsCase

getCreateTime()

public Timestamp getCreateTime()

Output only. The time the view was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the view was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public FileView getDefaultInstanceForType()
Returns
Type Description
FileView

getFileCharacteristics()

public FileCharacteristics getFileCharacteristics()

Output only. Characteristics of other file types.

.google.cloud.discoveryengine.v1alpha.FileCharacteristics file_characteristics = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
FileCharacteristics

The fileCharacteristics.

getFileCharacteristicsOrBuilder()

public FileCharacteristicsOrBuilder getFileCharacteristicsOrBuilder()

Output only. Characteristics of other file types.

.google.cloud.discoveryengine.v1alpha.FileCharacteristics file_characteristics = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
FileCharacteristicsOrBuilder

getImageCharacteristics()

public ImageCharacteristics getImageCharacteristics()

Output only. Characteristics of an image media view.

.google.cloud.discoveryengine.v1alpha.ImageCharacteristics image_characteristics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ImageCharacteristics

The imageCharacteristics.

getImageCharacteristicsOrBuilder()

public ImageCharacteristicsOrBuilder getImageCharacteristicsOrBuilder()

Output only. Characteristics of an image media view.

.google.cloud.discoveryengine.v1alpha.ImageCharacteristics image_characteristics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ImageCharacteristicsOrBuilder

getMimeType()

public String getMimeType()

Output only. MIME type (e.g., "image/jpeg", "image/png", "text/plain", "video/mp4")

string mime_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

Output only. MIME type (e.g., "image/jpeg", "image/png", "text/plain", "video/mp4")

string mime_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for mimeType.

getParserForType()

public Parser<FileView> getParserForType()
Returns
Type Description
Parser<FileView>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUri()

public String getUri()

Output only. The URI to access this media view.

string uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

Output only. The URI to access this media view.

string uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uri.

getVideoCharacteristics()

public VideoCharacteristics getVideoCharacteristics()

Output only. Characteristics of a video media view.

.google.cloud.discoveryengine.v1alpha.VideoCharacteristics video_characteristics = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
VideoCharacteristics

The videoCharacteristics.

getVideoCharacteristicsOrBuilder()

public VideoCharacteristicsOrBuilder getVideoCharacteristicsOrBuilder()

Output only. Characteristics of a video media view.

.google.cloud.discoveryengine.v1alpha.VideoCharacteristics video_characteristics = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
VideoCharacteristicsOrBuilder

getViewId()

public String getViewId()

Output only. Globally Unique id for this specific view.

string view_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The viewId.

getViewIdBytes()

public ByteString getViewIdBytes()

Output only. Globally Unique id for this specific view.

string view_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for viewId.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time the view was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasFileCharacteristics()

public boolean hasFileCharacteristics()

Output only. Characteristics of other file types.

.google.cloud.discoveryengine.v1alpha.FileCharacteristics file_characteristics = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the fileCharacteristics field is set.

hasImageCharacteristics()

public boolean hasImageCharacteristics()

Output only. Characteristics of an image media view.

.google.cloud.discoveryengine.v1alpha.ImageCharacteristics image_characteristics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the imageCharacteristics field is set.

hasVideoCharacteristics()

public boolean hasVideoCharacteristics()

Output only. Characteristics of a video media view.

.google.cloud.discoveryengine.v1alpha.VideoCharacteristics video_characteristics = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the videoCharacteristics field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FileView.Builder newBuilderForType()
Returns
Type Description
FileView.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FileView.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FileView.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FileView.Builder toBuilder()
Returns
Type Description
FileView.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException