Class RecommendRequest
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.discoveryengine.v1beta.RecommendRequest
-
- All Implemented Interfaces:
RecommendRequestOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
public final class RecommendRequest extends com.google.protobuf.GeneratedMessageV3 implements RecommendRequestOrBuilder
Request message for Recommend method.
Protobuf typegoogle.cloud.discoveryengine.v1beta.RecommendRequest- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classRecommendRequest.BuilderRequest message for Recommend method.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static intFILTER_FIELD_NUMBERstatic intPAGE_SIZE_FIELD_NUMBERstatic intPARAMS_FIELD_NUMBERstatic intSERVING_CONFIG_FIELD_NUMBERstatic intUSER_EVENT_FIELD_NUMBERstatic intUSER_LABELS_FIELD_NUMBERstatic intVALIDATE_ONLY_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleancontainsParams(String key)Additional domain specific parameters for the recommendations.booleancontainsUserLabels(String key)The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.booleanequals(Object obj)static RecommendRequestgetDefaultInstance()RecommendRequestgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()StringgetFilter()Filter for restricting recommendation results with a length limit of 5,000 characters.com.google.protobuf.ByteStringgetFilterBytes()Filter for restricting recommendation results with a length limit of 5,000 characters.intgetPageSize()Maximum number of results to return.Map<String,com.google.protobuf.Value>getParams()Deprecated.intgetParamsCount()Additional domain specific parameters for the recommendations.Map<String,com.google.protobuf.Value>getParamsMap()Additional domain specific parameters for the recommendations.com.google.protobuf.ValuegetParamsOrDefault(String key, com.google.protobuf.Value defaultValue)Additional domain specific parameters for the recommendations.com.google.protobuf.ValuegetParamsOrThrow(String key)Additional domain specific parameters for the recommendations.com.google.protobuf.Parser<RecommendRequest>getParserForType()intgetSerializedSize()StringgetServingConfig()Required.com.google.protobuf.ByteStringgetServingConfigBytes()Required.UserEventgetUserEvent()Required.UserEventOrBuildergetUserEventOrBuilder()Required.Map<String,String>getUserLabels()Deprecated.intgetUserLabelsCount()The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.Map<String,String>getUserLabelsMap()The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.StringgetUserLabelsOrDefault(String key, String defaultValue)The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.StringgetUserLabelsOrThrow(String key)The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.booleangetValidateOnly()Use validate only mode for this recommendation query.inthashCode()booleanhasUserEvent()Required.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)booleanisInitialized()static RecommendRequest.BuildernewBuilder()static RecommendRequest.BuildernewBuilder(RecommendRequest prototype)RecommendRequest.BuildernewBuilderForType()protected RecommendRequest.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static RecommendRequestparseDelimitedFrom(InputStream input)static RecommendRequestparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RecommendRequestparseFrom(byte[] data)static RecommendRequestparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RecommendRequestparseFrom(com.google.protobuf.ByteString data)static RecommendRequestparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RecommendRequestparseFrom(com.google.protobuf.CodedInputStream input)static RecommendRequestparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RecommendRequestparseFrom(InputStream input)static RecommendRequestparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static RecommendRequestparseFrom(ByteBuffer data)static RecommendRequestparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<RecommendRequest>parser()RecommendRequest.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
SERVING_CONFIG_FIELD_NUMBER
public static final int SERVING_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
USER_EVENT_FIELD_NUMBER
public static final int USER_EVENT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
VALIDATE_ONLY_FIELD_NUMBER
public static final int VALIDATE_ONLY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PARAMS_FIELD_NUMBER
public static final int PARAMS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
USER_LABELS_FIELD_NUMBER
public static final int USER_LABELS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getServingConfig
public String getServingConfig()
Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model, you must create at least one serving config for it.
string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Specified by:
getServingConfigin interfaceRecommendRequestOrBuilder- Returns:
- The servingConfig.
-
getServingConfigBytes
public com.google.protobuf.ByteString getServingConfigBytes()
Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model, you must create at least one serving config for it.
string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Specified by:
getServingConfigBytesin interfaceRecommendRequestOrBuilder- Returns:
- The bytes for servingConfig.
-
hasUserEvent
public boolean hasUserEvent()
Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] or [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id] to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] to a random unique ID and leave [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id] unset.
.google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
hasUserEventin interfaceRecommendRequestOrBuilder- Returns:
- Whether the userEvent field is set.
-
getUserEvent
public UserEvent getUserEvent()
Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] or [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id] to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] to a random unique ID and leave [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id] unset.
.google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getUserEventin interfaceRecommendRequestOrBuilder- Returns:
- The userEvent.
-
getUserEventOrBuilder
public UserEventOrBuilder getUserEventOrBuilder()
Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] or [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id] to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] to a random unique ID and leave [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id] unset.
.google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getUserEventOrBuilderin interfaceRecommendRequestOrBuilder
-
getPageSize
public int getPageSize()
Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100.
int32 page_size = 3;- Specified by:
getPageSizein interfaceRecommendRequestOrBuilder- Returns:
- The pageSize.
-
getFilter
public String getFilter()
Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params] to receive empty results instead. Note that the API will never return [Document][google.cloud.discoveryengine.v1beta.Document]s with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.string filter = 4;- Specified by:
getFilterin interfaceRecommendRequestOrBuilder- Returns:
- The filter.
-
getFilterBytes
public com.google.protobuf.ByteString getFilterBytes()
Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params] to receive empty results instead. Note that the API will never return [Document][google.cloud.discoveryengine.v1beta.Document]s with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.string filter = 4;- Specified by:
getFilterBytesin interfaceRecommendRequestOrBuilder- Returns:
- The bytes for filter.
-
getValidateOnly
public boolean getValidateOnly()
Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.
bool validate_only = 5;- Specified by:
getValidateOnlyin interfaceRecommendRequestOrBuilder- Returns:
- The validateOnly.
-
getParamsCount
public int getParamsCount()
Description copied from interface:RecommendRequestOrBuilderAdditional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document]. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata]. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category.map<string, .google.protobuf.Value> params = 6;- Specified by:
getParamsCountin interfaceRecommendRequestOrBuilder
-
containsParams
public boolean containsParams(String key)
Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document]. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata]. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category.map<string, .google.protobuf.Value> params = 6;- Specified by:
containsParamsin interfaceRecommendRequestOrBuilder
-
getParams
@Deprecated public Map<String,com.google.protobuf.Value> getParams()
Deprecated.UsegetParamsMap()instead.- Specified by:
getParamsin interfaceRecommendRequestOrBuilder
-
getParamsMap
public Map<String,com.google.protobuf.Value> getParamsMap()
Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document]. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata]. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category.map<string, .google.protobuf.Value> params = 6;- Specified by:
getParamsMapin interfaceRecommendRequestOrBuilder
-
getParamsOrDefault
public com.google.protobuf.Value getParamsOrDefault(String key, com.google.protobuf.Value defaultValue)
Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document]. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata]. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category.map<string, .google.protobuf.Value> params = 6;- Specified by:
getParamsOrDefaultin interfaceRecommendRequestOrBuilder
-
getParamsOrThrow
public com.google.protobuf.Value getParamsOrThrow(String key)
Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document]. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata]. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category.map<string, .google.protobuf.Value> params = 6;- Specified by:
getParamsOrThrowin interfaceRecommendRequestOrBuilder
-
getUserLabelsCount
public int getUserLabelsCount()
Description copied from interface:RecommendRequestOrBuilderThe user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 8;- Specified by:
getUserLabelsCountin interfaceRecommendRequestOrBuilder
-
containsUserLabels
public boolean containsUserLabels(String key)
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 8;- Specified by:
containsUserLabelsin interfaceRecommendRequestOrBuilder
-
getUserLabels
@Deprecated public Map<String,String> getUserLabels()
Deprecated.UsegetUserLabelsMap()instead.- Specified by:
getUserLabelsin interfaceRecommendRequestOrBuilder
-
getUserLabelsMap
public Map<String,String> getUserLabelsMap()
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 8;- Specified by:
getUserLabelsMapin interfaceRecommendRequestOrBuilder
-
getUserLabelsOrDefault
public String getUserLabelsOrDefault(String key, String defaultValue)
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 8;- Specified by:
getUserLabelsOrDefaultin interfaceRecommendRequestOrBuilder
-
getUserLabelsOrThrow
public String getUserLabelsOrThrow(String key)
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 8;- Specified by:
getUserLabelsOrThrowin interfaceRecommendRequestOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static RecommendRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RecommendRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RecommendRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RecommendRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RecommendRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RecommendRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RecommendRequest parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static RecommendRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static RecommendRequest parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static RecommendRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static RecommendRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static RecommendRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public RecommendRequest.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static RecommendRequest.Builder newBuilder()
-
newBuilder
public static RecommendRequest.Builder newBuilder(RecommendRequest prototype)
-
toBuilder
public RecommendRequest.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RecommendRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static RecommendRequest getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<RecommendRequest> parser()
-
getParserForType
public com.google.protobuf.Parser<RecommendRequest> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public RecommendRequest getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-