Send feedback
Class ListRecommendationsRequest (2.19.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.19.0 keyboard_arrow_down
public final class ListRecommendationsRequest extends GeneratedMessageV3 implements ListRecommendationsRequestOrBuilder
Request for the ListRecommendations method.
Protobuf type google.cloud.recommender.v1beta1.ListRecommendationsRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value Type Description int
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value Type Description int
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value Type Description int
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value Type Description int
Static Methods
getDefaultInstance()
public static ListRecommendationsRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ListRecommendationsRequest . Builder newBuilder ()
newBuilder(ListRecommendationsRequest prototype)
public static ListRecommendationsRequest . Builder newBuilder ( ListRecommendationsRequest prototype )
public static ListRecommendationsRequest parseDelimitedFrom ( InputStream input )
public static ListRecommendationsRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ListRecommendationsRequest parseFrom ( byte [] data )
Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListRecommendationsRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ListRecommendationsRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListRecommendationsRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ListRecommendationsRequest parseFrom ( CodedInputStream input )
public static ListRecommendationsRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ListRecommendationsRequest parseFrom ( InputStream input )
public static ListRecommendationsRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ListRecommendationsRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListRecommendationsRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ListRecommendationsRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description objObject
Overrides
getDefaultInstanceForType()
public ListRecommendationsRequest getDefaultInstanceForType ()
getFilter()
public String getFilter ()
Filter expression to restrict the recommendations returned. Supported
filter fields:
state_info.staterecommenderSubtypepriority
Examples:stateInfo.state = ACTIVE OR stateInfo.state = DISMISSEDrecommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLEpriority = P1 OR priority = P2stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)
(These expressions are based on the filter language described at
https://google.aip.dev/160 )
string filter = 5;
Returns Type Description String The filter.
getFilterBytes()
public ByteString getFilterBytes ()
Filter expression to restrict the recommendations returned. Supported
filter fields:
state_info.staterecommenderSubtypepriority
Examples:stateInfo.state = ACTIVE OR stateInfo.state = DISMISSEDrecommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLEpriority = P1 OR priority = P2stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)
(These expressions are based on the filter language described at
https://google.aip.dev/160 )
string filter = 5;
Returns Type Description ByteString The bytes for filter.
getPageSize()
Optional. The maximum number of results to return from this request. Non-positive
values are ignored. If not specified, the server will determine the number
of results to return.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns Type Description int The pageSize.
getPageToken()
public String getPageToken ()
Optional. If present, retrieves the next batch of results from the preceding call to
this method. page_token must be the value of next_page_token from the
previous response. The values of other method parameters must be identical
to those in the previous call.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns Type Description String The pageToken.
getPageTokenBytes()
public ByteString getPageTokenBytes ()
Optional. If present, retrieves the next batch of results from the preceding call to
this method. page_token must be the value of next_page_token from the
previous response. The values of other method parameters must be identical
to those in the previous call.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns Type Description ByteString The bytes for pageToken.
getParent()
public String getParent ()
Required. The container resource on which to execute the request.
Acceptable formats:
projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
LOCATION here refers to GCP Locations:
https://cloud.google.com/about/locations/
RECOMMENDER_ID refers to supported recommenders:
https://cloud.google.com/recommender/docs/recommenders .
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns Type Description String The parent.
getParentBytes()
public ByteString getParentBytes ()
Required. The container resource on which to execute the request.
Acceptable formats:
projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]
LOCATION here refers to GCP Locations:
https://cloud.google.com/about/locations/
RECOMMENDER_ID refers to supported recommenders:
https://cloud.google.com/recommender/docs/recommenders .
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns Type Description ByteString The bytes for parent.
getParserForType()
public Parser<ListRecommendationsRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ListRecommendationsRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListRecommendationsRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public ListRecommendationsRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-21 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-21 UTC."],[],[]]
