Package com.google.cloud.recommendationengine.v1beta1

Class PredictResponse

  • All Implemented Interfaces:
    PredictResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class PredictResponse
extends com.google.protobuf.GeneratedMessageV3
implements PredictResponseOrBuilder
     Response message for predict method.
    Protobuf type google.cloud.recommendationengine.v1beta1.PredictResponse
    See Also:
    Serialized Form

    • Field Detail

      • RECOMMENDATION_TOKEN_FIELD_NUMBER

        public static final int RECOMMENDATION_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ITEMS_MISSING_IN_CATALOG_FIELD_NUMBER

        public static final int ITEMS_MISSING_IN_CATALOG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NEXT_PAGE_TOKEN_FIELD_NUMBER

        public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getResultsCount

        public int getResultsCount()
         A list of recommended items. The order represents the ranking (from the
 most relevant item to the least).
        repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;
        Specified by:
        getResultsCount in interface PredictResponseOrBuilder

      • getResults

        public PredictResponse.PredictionResult getResults​(int index)
         A list of recommended items. The order represents the ranking (from the
 most relevant item to the least).
        repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;
        Specified by:
        getResults in interface PredictResponseOrBuilder

      • getRecommendationToken

        public String getRecommendationToken()
         A unique recommendation token. This should be included in the user event
 logs resulting from this recommendation, which enables accurate attribution
 of recommendation model performance.
        string recommendation_token = 2;
        Specified by:
        getRecommendationToken in interface PredictResponseOrBuilder
        Returns:
        The recommendationToken.

      • getRecommendationTokenBytes

        public com.google.protobuf.ByteString getRecommendationTokenBytes()
         A unique recommendation token. This should be included in the user event
 logs resulting from this recommendation, which enables accurate attribution
 of recommendation model performance.
        string recommendation_token = 2;
        Specified by:
        getRecommendationTokenBytes in interface PredictResponseOrBuilder
        Returns:
        The bytes for recommendationToken.

      • getItemsMissingInCatalogList

        public com.google.protobuf.ProtocolStringList getItemsMissingInCatalogList()
         IDs of items in the request that were missing from the catalog.
        repeated string items_missing_in_catalog = 3;
        Specified by:
        getItemsMissingInCatalogList in interface PredictResponseOrBuilder
        Returns:
        A list containing the itemsMissingInCatalog.

      • getItemsMissingInCatalogCount

        public int getItemsMissingInCatalogCount()
         IDs of items in the request that were missing from the catalog.
        repeated string items_missing_in_catalog = 3;
        Specified by:
        getItemsMissingInCatalogCount in interface PredictResponseOrBuilder
        Returns:
        The count of itemsMissingInCatalog.

      • getItemsMissingInCatalog

        public String getItemsMissingInCatalog​(int index)
         IDs of items in the request that were missing from the catalog.
        repeated string items_missing_in_catalog = 3;
        Specified by:
        getItemsMissingInCatalog in interface PredictResponseOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The itemsMissingInCatalog at the given index.

      • getItemsMissingInCatalogBytes

        public com.google.protobuf.ByteString getItemsMissingInCatalogBytes​(int index)
         IDs of items in the request that were missing from the catalog.
        repeated string items_missing_in_catalog = 3;
        Specified by:
        getItemsMissingInCatalogBytes in interface PredictResponseOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the itemsMissingInCatalog at the given index.

      • getDryRun

        public boolean getDryRun()
         True if the dryRun property was set in the request.
        bool dry_run = 4;
        Specified by:
        getDryRun in interface PredictResponseOrBuilder
        Returns:
        The dryRun.

      • containsMetadata

        public boolean containsMetadata​(String key)
         Additional domain specific prediction response metadata.
        map<string, .google.protobuf.Value> metadata = 5;
        Specified by:
        containsMetadata in interface PredictResponseOrBuilder

      • getMetadataMap

        public Map<String,​com.google.protobuf.Value> getMetadataMap()
         Additional domain specific prediction response metadata.
        map<string, .google.protobuf.Value> metadata = 5;
        Specified by:
        getMetadataMap in interface PredictResponseOrBuilder

      • getMetadataOrDefault

        public com.google.protobuf.Value getMetadataOrDefault​(String key,
                                                      com.google.protobuf.Value defaultValue)
         Additional domain specific prediction response metadata.
        map<string, .google.protobuf.Value> metadata = 5;
        Specified by:
        getMetadataOrDefault in interface PredictResponseOrBuilder

      • getMetadataOrThrow

        public com.google.protobuf.Value getMetadataOrThrow​(String key)
         Additional domain specific prediction response metadata.
        map<string, .google.protobuf.Value> metadata = 5;
        Specified by:
        getMetadataOrThrow in interface PredictResponseOrBuilder

      • getNextPageToken

        public String getNextPageToken()
         If empty, the list is complete. If nonempty, the token to pass to the next
 request's PredictRequest.page_token.
        string next_page_token = 6;
        Specified by:
        getNextPageToken in interface PredictResponseOrBuilder
        Returns:
        The nextPageToken.

      • getNextPageTokenBytes

        public com.google.protobuf.ByteString getNextPageTokenBytes()
         If empty, the list is complete. If nonempty, the token to pass to the next
 request's PredictRequest.page_token.
        string next_page_token = 6;
        Specified by:
        getNextPageTokenBytes in interface PredictResponseOrBuilder
        Returns:
        The bytes for nextPageToken.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 PredictResponse parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected PredictResponse.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<PredictResponse> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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