Package com.google.cloud.aiplatform.v1

Class Part

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Part
All Implemented Interfaces:
PartOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Part extends com.google.protobuf.GeneratedMessage 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.v1.Part
See Also:

  • Field Details

    • TEXT_FIELD_NUMBER

      public static final int TEXT_FIELD_NUMBER
      See Also:

    • INLINE_DATA_FIELD_NUMBER

      public static final int INLINE_DATA_FIELD_NUMBER
      See Also:

    • FILE_DATA_FIELD_NUMBER

      public static final int FILE_DATA_FIELD_NUMBER
      See Also:

    • FUNCTION_CALL_FIELD_NUMBER

      public static final int FUNCTION_CALL_FIELD_NUMBER
      See Also:

    • FUNCTION_RESPONSE_FIELD_NUMBER

      public static final int FUNCTION_RESPONSE_FIELD_NUMBER
      See Also:

    • EXECUTABLE_CODE_FIELD_NUMBER

      public static final int EXECUTABLE_CODE_FIELD_NUMBER
      See Also:

    • CODE_EXECUTION_RESULT_FIELD_NUMBER

      public static final int CODE_EXECUTION_RESULT_FIELD_NUMBER
      See Also:

    • THOUGHT_FIELD_NUMBER

      public static final int THOUGHT_FIELD_NUMBER
      See Also:

    • THOUGHT_SIGNATURE_FIELD_NUMBER

      public static final int THOUGHT_SIGNATURE_FIELD_NUMBER
      See Also:

    • VIDEO_METADATA_FIELD_NUMBER

      public static final int VIDEO_METADATA_FIELD_NUMBER
      See Also:

    • MEDIA_RESOLUTION_FIELD_NUMBER

      public static final int MEDIA_RESOLUTION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getDataCase

      public Part.DataCase getDataCase()
      Specified by:
      getDataCase in interface PartOrBuilder

    • getMetadataCase

      public Part.MetadataCase getMetadataCase()
      Specified by:
      getMetadataCase in interface PartOrBuilder

    • hasText

      public boolean hasText()
       Optional. Text part (can be code).
      string text = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasText in interface PartOrBuilder
      Returns:
      Whether the text field is set.

    • getText

      public String getText()
       Optional. Text part (can be code).
      string text = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getText in interface PartOrBuilder
      Returns:
      The text.

    • getTextBytes

      public com.google.protobuf.ByteString getTextBytes()
       Optional. Text part (can be code).
      string text = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTextBytes in interface PartOrBuilder
      Returns:
      The bytes for text.

    • hasInlineData

      public boolean hasInlineData()
       Optional. Inlined bytes data.
      .google.cloud.aiplatform.v1.Blob inline_data = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasInlineData in interface PartOrBuilder
      Returns:
      Whether the inlineData field is set.

    • getInlineData

      public Blob getInlineData()
       Optional. Inlined bytes data.
      .google.cloud.aiplatform.v1.Blob inline_data = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInlineData in interface PartOrBuilder
      Returns:
      The inlineData.

    • getInlineDataOrBuilder

      public BlobOrBuilder getInlineDataOrBuilder()
       Optional. Inlined bytes data.
      .google.cloud.aiplatform.v1.Blob inline_data = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInlineDataOrBuilder in interface PartOrBuilder

    • hasFileData

      public boolean hasFileData()
       Optional. URI based data.
      .google.cloud.aiplatform.v1.FileData file_data = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasFileData in interface PartOrBuilder
      Returns:
      Whether the fileData field is set.

    • getFileData

      public FileData getFileData()
       Optional. URI based data.
      .google.cloud.aiplatform.v1.FileData file_data = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFileData in interface PartOrBuilder
      Returns:
      The fileData.

    • getFileDataOrBuilder

      public FileDataOrBuilder getFileDataOrBuilder()
       Optional. URI based data.
      .google.cloud.aiplatform.v1.FileData file_data = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFileDataOrBuilder in interface PartOrBuilder

    • 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.v1.FunctionCall function_call = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasFunctionCall in interface PartOrBuilder
      Returns:
      Whether the functionCall field is set.

    • 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.v1.FunctionCall function_call = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFunctionCall in interface PartOrBuilder
      Returns:
      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.v1.FunctionCall function_call = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFunctionCallOrBuilder in interface PartOrBuilder

    • hasFunctionResponse

      public boolean hasFunctionResponse()
       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.v1.FunctionResponse function_response = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasFunctionResponse in interface PartOrBuilder
      Returns:
      Whether the functionResponse field is set.

    • 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.v1.FunctionResponse function_response = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFunctionResponse in interface PartOrBuilder
      Returns:
      The functionResponse.

    • getFunctionResponseOrBuilder

      public FunctionResponseOrBuilder getFunctionResponseOrBuilder()
       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.v1.FunctionResponse function_response = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFunctionResponseOrBuilder in interface PartOrBuilder

    • hasExecutableCode

      public boolean hasExecutableCode()
       Optional. Code generated by the model that is meant to be executed.
      .google.cloud.aiplatform.v1.ExecutableCode executable_code = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasExecutableCode in interface PartOrBuilder
      Returns:
      Whether the executableCode field is set.

    • getExecutableCode

      public ExecutableCode getExecutableCode()
       Optional. Code generated by the model that is meant to be executed.
      .google.cloud.aiplatform.v1.ExecutableCode executable_code = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExecutableCode in interface PartOrBuilder
      Returns:
      The executableCode.

    • getExecutableCodeOrBuilder

      public ExecutableCodeOrBuilder getExecutableCodeOrBuilder()
       Optional. Code generated by the model that is meant to be executed.
      .google.cloud.aiplatform.v1.ExecutableCode executable_code = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExecutableCodeOrBuilder in interface PartOrBuilder

    • hasCodeExecutionResult

      public boolean hasCodeExecutionResult()
       Optional. Result of executing the [ExecutableCode].
      .google.cloud.aiplatform.v1.CodeExecutionResult code_execution_result = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCodeExecutionResult in interface PartOrBuilder
      Returns:
      Whether the codeExecutionResult field is set.

    • getCodeExecutionResult

      public CodeExecutionResult getCodeExecutionResult()
       Optional. Result of executing the [ExecutableCode].
      .google.cloud.aiplatform.v1.CodeExecutionResult code_execution_result = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCodeExecutionResult in interface PartOrBuilder
      Returns:
      The codeExecutionResult.

    • getCodeExecutionResultOrBuilder

      public CodeExecutionResultOrBuilder getCodeExecutionResultOrBuilder()
       Optional. Result of executing the [ExecutableCode].
      .google.cloud.aiplatform.v1.CodeExecutionResult code_execution_result = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCodeExecutionResultOrBuilder in interface PartOrBuilder

    • getThought

      public boolean getThought()
       Indicates if the part is thought from the model.
      bool thought = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getThought in interface PartOrBuilder
      Returns:
      The thought.

    • getThoughtSignature

      public com.google.protobuf.ByteString getThoughtSignature()
       An opaque signature for the thought so it can be reused in subsequent
 requests.
      bytes thought_signature = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getThoughtSignature in interface PartOrBuilder
      Returns:
      The thoughtSignature.

    • 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.v1.VideoMetadata video_metadata = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasVideoMetadata in interface PartOrBuilder
      Returns:
      Whether the videoMetadata field is set.

    • 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.v1.VideoMetadata video_metadata = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getVideoMetadata in interface PartOrBuilder
      Returns:
      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.v1.VideoMetadata video_metadata = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getVideoMetadataOrBuilder in interface PartOrBuilder

    • hasMediaResolution

      public boolean hasMediaResolution()
       per part media resolution.
 Media resolution for the input media.
      .google.cloud.aiplatform.v1.Part.MediaResolution media_resolution = 12;
      Specified by:
      hasMediaResolution in interface PartOrBuilder
      Returns:
      Whether the mediaResolution field is set.

    • getMediaResolution

      public Part.MediaResolution getMediaResolution()
       per part media resolution.
 Media resolution for the input media.
      .google.cloud.aiplatform.v1.Part.MediaResolution media_resolution = 12;
      Specified by:
      getMediaResolution in interface PartOrBuilder
      Returns:
      The mediaResolution.

    • getMediaResolutionOrBuilder

      public Part.MediaResolutionOrBuilder getMediaResolutionOrBuilder()
       per part media resolution.
 Media resolution for the input media.
      .google.cloud.aiplatform.v1.Part.MediaResolution media_resolution = 12;
      Specified by:
      getMediaResolutionOrBuilder in interface PartOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Part parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Part parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Part parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Part parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Part parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Part parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Part parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Part parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Part parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Part parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Part parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Part parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Part.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Part.Builder newBuilder()

    • newBuilder

      public static Part.Builder newBuilder(Part prototype)

    • toBuilder

      public Part.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Part.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Part getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Part> parser()

    • getParserForType

      public com.google.protobuf.Parser<Part> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Part getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder