Class Part (3.55.0)

public final class Part extends GeneratedMessageV3 implements PartOrBuilder

A datatype containing media that is part of a multi-part Content message.

A Part consists of data which has an associated datatype. A Part can only contain one of the accepted types in Part.data.

A Part must have a fixed IANA MIME type identifying the type and subtype of the media if inline_data or file_data field is filled with raw bytes.

Protobuf type google.cloud.aiplatform.v1beta1.Part

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Part

Implements

PartOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CODE_EXECUTION_RESULT_FIELD_NUMBER

public static final int CODE_EXECUTION_RESULT_FIELD_NUMBER

Field Value
Type	Description
`int`

EXECUTABLE_CODE_FIELD_NUMBER

public static final int EXECUTABLE_CODE_FIELD_NUMBER

Field Value
Type	Description
`int`

FILE_DATA_FIELD_NUMBER

public static final int FILE_DATA_FIELD_NUMBER

Field Value
Type	Description
`int`

FUNCTION_CALL_FIELD_NUMBER

public static final int FUNCTION_CALL_FIELD_NUMBER

Field Value
Type	Description
`int`

FUNCTION_RESPONSE_FIELD_NUMBER

public static final int FUNCTION_RESPONSE_FIELD_NUMBER

Field Value
Type	Description
`int`

INLINE_DATA_FIELD_NUMBER

public static final int INLINE_DATA_FIELD_NUMBER

Field Value
Type	Description
`int`

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER

Field Value
Type	Description
`int`

VIDEO_METADATA_FIELD_NUMBER

public static final int VIDEO_METADATA_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static Part getDefaultInstance()

Returns
Type	Description
`Part`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Part.Builder newBuilder()

Returns
Type	Description
`Part.Builder`

newBuilder(Part prototype)

public static Part.Builder newBuilder(Part prototype)

Parameter
Name	Description
`prototype`	`Part`

Returns
Type	Description
`Part.Builder`

parseDelimitedFrom(InputStream input)

public static Part parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Part`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Part parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Part`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Part parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Part`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Part parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Part`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Part parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Part`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Part parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Part`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Part parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Part`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Part parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Returns
Type	Description
`Part`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Part parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Part`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Part parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Part`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Part parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Part`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Part parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Part`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Part> parser()

Returns
Type	Description
`Parser<Part>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getCodeExecutionResult()

public CodeExecutionResult getCodeExecutionResult()

Optional. Result of executing the [ExecutableCode].

.google.cloud.aiplatform.v1beta1.CodeExecutionResult code_execution_result = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`CodeExecutionResult`	The codeExecutionResult.

getCodeExecutionResultOrBuilder()

public CodeExecutionResultOrBuilder getCodeExecutionResultOrBuilder()

Optional. Result of executing the [ExecutableCode].

.google.cloud.aiplatform.v1beta1.CodeExecutionResult code_execution_result = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`CodeExecutionResultOrBuilder`

getDataCase()

public Part.DataCase getDataCase()

Returns
Type	Description
`Part.DataCase`

getDefaultInstanceForType()

public Part getDefaultInstanceForType()

Returns
Type	Description
`Part`

getExecutableCode()

public ExecutableCode getExecutableCode()

Optional. Code generated by the model that is meant to be executed.

.google.cloud.aiplatform.v1beta1.ExecutableCode executable_code = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ExecutableCode`	The executableCode.

getExecutableCodeOrBuilder()

public ExecutableCodeOrBuilder getExecutableCodeOrBuilder()

Optional. Code generated by the model that is meant to be executed.

.google.cloud.aiplatform.v1beta1.ExecutableCode executable_code = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ExecutableCodeOrBuilder`

getFileData()

public FileData getFileData()

Optional. URI based data.

.google.cloud.aiplatform.v1beta1.FileData file_data = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FileData`	The fileData.

getFileDataOrBuilder()

public FileDataOrBuilder getFileDataOrBuilder()

Optional. URI based data.

.google.cloud.aiplatform.v1beta1.FileData file_data = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FileDataOrBuilder`

getFunctionCall()

public FunctionCall getFunctionCall()

Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.

.google.cloud.aiplatform.v1beta1.FunctionCall function_call = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FunctionCall`	The functionCall.

getFunctionCallOrBuilder()

public FunctionCallOrBuilder getFunctionCallOrBuilder()

Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.

.google.cloud.aiplatform.v1beta1.FunctionCall function_call = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FunctionCallOrBuilder`

getFunctionResponse()

public FunctionResponse getFunctionResponse()

Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.

.google.cloud.aiplatform.v1beta1.FunctionResponse function_response = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FunctionResponse`	The functionResponse.

getFunctionResponseOrBuilder()

public FunctionResponseOrBuilder getFunctionResponseOrBuilder()

.google.cloud.aiplatform.v1beta1.FunctionResponse function_response = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FunctionResponseOrBuilder`

getInlineData()

public Blob getInlineData()

Optional. Inlined bytes data.

.google.cloud.aiplatform.v1beta1.Blob inline_data = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Blob`	The inlineData.

getInlineDataOrBuilder()

public BlobOrBuilder getInlineDataOrBuilder()

Optional. Inlined bytes data.

.google.cloud.aiplatform.v1beta1.Blob inline_data = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`BlobOrBuilder`

getMetadataCase()

public Part.MetadataCase getMetadataCase()

Returns
Type	Description
`Part.MetadataCase`

getParserForType()

public Parser<Part> getParserForType()

Returns
Type	Description
`Parser<Part>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getText()

public String getText()

Optional. Text part (can be code).

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The text.

getTextBytes()

public ByteString getTextBytes()

Optional. Text part (can be code).

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for text.

getVideoMetadata()

public VideoMetadata getVideoMetadata()

Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.

.google.cloud.aiplatform.v1beta1.VideoMetadata video_metadata = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`VideoMetadata`	The videoMetadata.

getVideoMetadataOrBuilder()

public VideoMetadataOrBuilder getVideoMetadataOrBuilder()

Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.

.google.cloud.aiplatform.v1beta1.VideoMetadata video_metadata = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`VideoMetadataOrBuilder`

hasCodeExecutionResult()

public boolean hasCodeExecutionResult()

Optional. Result of executing the [ExecutableCode].

.google.cloud.aiplatform.v1beta1.CodeExecutionResult code_execution_result = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the codeExecutionResult field is set.

hasExecutableCode()

public boolean hasExecutableCode()

Optional. Code generated by the model that is meant to be executed.

.google.cloud.aiplatform.v1beta1.ExecutableCode executable_code = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the executableCode field is set.

hasFileData()

public boolean hasFileData()

Optional. URI based data.

.google.cloud.aiplatform.v1beta1.FileData file_data = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the fileData field is set.

hasFunctionCall()

public boolean hasFunctionCall()

Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.

.google.cloud.aiplatform.v1beta1.FunctionCall function_call = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the functionCall field is set.

hasFunctionResponse()

public boolean hasFunctionResponse()

.google.cloud.aiplatform.v1beta1.FunctionResponse function_response = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the functionResponse field is set.

hasInlineData()

public boolean hasInlineData()

Optional. Inlined bytes data.

.google.cloud.aiplatform.v1beta1.Blob inline_data = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the inlineData field is set.

hasText()

public boolean hasText()

Optional. Text part (can be code).

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the text field is set.

hasVideoMetadata()

public boolean hasVideoMetadata()

Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.

.google.cloud.aiplatform.v1beta1.VideoMetadata video_metadata = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the videoMetadata field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Part.Builder newBuilderForType()

Returns
Type	Description
`Part.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Part.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`Part.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Part.Builder toBuilder()

Returns
Type	Description
`Part.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`