com.google.cloud.recommender.v1

Interface ListRecommendationsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListRecommendationsRequest, ListRecommendationsRequest.Builder

public interface ListRecommendationsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() Filter expression to restrict the recommendations returned.
com.google.protobuf.ByteString	getFilterBytes() Filter expression to restrict the recommendations returned.
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

 Required. The container resource on which to execute the request.
 Acceptable formats:
 1.
 "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]",
 LOCATION here refers to GCP Locations:
 https://cloud.google.com/about/locations/
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

 Required. The container resource on which to execute the request.
 Acceptable formats:
 1.
 "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]",
 LOCATION here refers to GCP Locations:
 https://cloud.google.com/about/locations/
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for parent.

getPageSize

int 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:

The pageSize.

getPageToken

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:

The pageToken.

getPageTokenBytes

com.google.protobuf.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:

The bytes for pageToken.

getFilter

String getFilter()

 Filter expression to restrict the recommendations returned. Supported
 filter fields: state_info.state
 Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"
 

string filter = 5;

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 Filter expression to restrict the recommendations returned. Supported
 filter fields: state_info.state
 Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"
 

string filter = 5;

Returns:

The bytes for filter.