Package com.google.cloud.discoveryengine.v1beta

Class RecommendResponse.RecommendationResult.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<RecommendResponse.RecommendationResult.Builder>
com.google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.Builder
All Implemented Interfaces:
RecommendResponse.RecommendationResultOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RecommendResponse.RecommendationResult
public static final class RecommendResponse.RecommendationResult.Builder extends com.google.protobuf.GeneratedMessage.Builder<RecommendResponse.RecommendationResult.Builder> implements RecommendResponse.RecommendationResultOrBuilder
 RecommendationResult represents a generic recommendation result with
 associated metadata.
Protobuf type google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<RecommendResponse.RecommendationResult.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<RecommendResponse.RecommendationResult.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RecommendResponse.RecommendationResult.Builder>

    • clear

      public RecommendResponse.RecommendationResult.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<RecommendResponse.RecommendationResult.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<RecommendResponse.RecommendationResult.Builder>

    • getDefaultInstanceForType

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

    • build

      public RecommendResponse.RecommendationResult build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public RecommendResponse.RecommendationResult buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public RecommendResponse.RecommendationResult.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RecommendResponse.RecommendationResult.Builder>

    • mergeFrom

      public RecommendResponse.RecommendationResult.Builder mergeFrom(RecommendResponse.RecommendationResult other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RecommendResponse.RecommendationResult.Builder>

    • mergeFrom

      public RecommendResponse.RecommendationResult.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RecommendResponse.RecommendationResult.Builder>
      Throws:
      IOException

    • getId

      public String getId()
       Resource ID of the recommended Document.
      string id = 1;
      Specified by:
      getId in interface RecommendResponse.RecommendationResultOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
       Resource ID of the recommended Document.
      string id = 1;
      Specified by:
      getIdBytes in interface RecommendResponse.RecommendationResultOrBuilder
      Returns:
      The bytes for id.

    • setId

      public RecommendResponse.RecommendationResult.Builder setId(String value)
       Resource ID of the recommended Document.
      string id = 1;
      Parameters:
      value - The id to set.
      Returns:
      This builder for chaining.

    • clearId

      public RecommendResponse.RecommendationResult.Builder clearId()
       Resource ID of the recommended Document.
      string id = 1;
      Returns:
      This builder for chaining.

    • setIdBytes

      public RecommendResponse.RecommendationResult.Builder setIdBytes(com.google.protobuf.ByteString value)
       Resource ID of the recommended Document.
      string id = 1;
      Parameters:
      value - The bytes for id to set.
      Returns:
      This builder for chaining.

    • hasDocument

      public boolean hasDocument()
       Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      .google.cloud.discoveryengine.v1beta.Document document = 2;
      Specified by:
      hasDocument in interface RecommendResponse.RecommendationResultOrBuilder
      Returns:
      Whether the document field is set.

    • getDocument

      public Document getDocument()
       Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      .google.cloud.discoveryengine.v1beta.Document document = 2;
      Specified by:
      getDocument in interface RecommendResponse.RecommendationResultOrBuilder
      Returns:
      The document.

    • setDocument

      public RecommendResponse.RecommendationResult.Builder setDocument(Document value)
       Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      .google.cloud.discoveryengine.v1beta.Document document = 2;

    • setDocument

      public RecommendResponse.RecommendationResult.Builder setDocument(Document.Builder builderForValue)
       Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      .google.cloud.discoveryengine.v1beta.Document document = 2;

    • mergeDocument

      public RecommendResponse.RecommendationResult.Builder mergeDocument(Document value)
       Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      .google.cloud.discoveryengine.v1beta.Document document = 2;

    • clearDocument

      public RecommendResponse.RecommendationResult.Builder clearDocument()
       Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      .google.cloud.discoveryengine.v1beta.Document document = 2;

    • getDocumentBuilder

      public Document.Builder getDocumentBuilder()
       Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      .google.cloud.discoveryengine.v1beta.Document document = 2;

    • getDocumentOrBuilder

      public DocumentOrBuilder getDocumentOrBuilder()
       Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      .google.cloud.discoveryengine.v1beta.Document document = 2;
      Specified by:
      getDocumentOrBuilder in interface RecommendResponse.RecommendationResultOrBuilder

    • getMetadataCount

      public int getMetadataCount()
      Description copied from interface: RecommendResponse.RecommendationResultOrBuilder
       Additional Document metadata or annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
 `returnScore` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      map<string, .google.protobuf.Value> metadata = 3;
      Specified by:
      getMetadataCount in interface RecommendResponse.RecommendationResultOrBuilder

    • containsMetadata

      public boolean containsMetadata(String key)
       Additional Document metadata or annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
 `returnScore` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      map<string, .google.protobuf.Value> metadata = 3;
      Specified by:
      containsMetadata in interface RecommendResponse.RecommendationResultOrBuilder

    • getMetadata

      @Deprecated public Map<String,com.google.protobuf.Value> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.
      Specified by:
      getMetadata in interface RecommendResponse.RecommendationResultOrBuilder

    • getMetadataMap

      public Map<String,com.google.protobuf.Value> getMetadataMap()
       Additional Document metadata or annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
 `returnScore` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      map<string, .google.protobuf.Value> metadata = 3;
      Specified by:
      getMetadataMap in interface RecommendResponse.RecommendationResultOrBuilder

    • getMetadataOrDefault

      public com.google.protobuf.Value getMetadataOrDefault(String key, com.google.protobuf.Value defaultValue)
       Additional Document metadata or annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
 `returnScore` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      map<string, .google.protobuf.Value> metadata = 3;
      Specified by:
      getMetadataOrDefault in interface RecommendResponse.RecommendationResultOrBuilder

    • getMetadataOrThrow

      public com.google.protobuf.Value getMetadataOrThrow(String key)
       Additional Document metadata or annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
 `returnScore` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      map<string, .google.protobuf.Value> metadata = 3;
      Specified by:
      getMetadataOrThrow in interface RecommendResponse.RecommendationResultOrBuilder

    • clearMetadata

      public RecommendResponse.RecommendationResult.Builder clearMetadata()

    • removeMetadata

      public RecommendResponse.RecommendationResult.Builder removeMetadata(String key)
       Additional Document metadata or annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
 `returnScore` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      map<string, .google.protobuf.Value> metadata = 3;

    • getMutableMetadata

      @Deprecated public Map<String,com.google.protobuf.Value> getMutableMetadata()
      Deprecated.
      Use alternate mutation accessors instead.

    • putMetadata

      public RecommendResponse.RecommendationResult.Builder putMetadata(String key, com.google.protobuf.Value value)
       Additional Document metadata or annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
 `returnScore` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      map<string, .google.protobuf.Value> metadata = 3;

    • putAllMetadata

      public RecommendResponse.RecommendationResult.Builder putAllMetadata(Map<String,com.google.protobuf.Value> values)
       Additional Document metadata or annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
 `returnScore` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      map<string, .google.protobuf.Value> metadata = 3;

    • putMetadataBuilderIfAbsent

      public com.google.protobuf.Value.Builder putMetadataBuilderIfAbsent(String key)
       Additional Document metadata or annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
 `returnScore` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
      map<string, .google.protobuf.Value> metadata = 3;