Class ListRecommendationsRequest (2.2.0)

public final class ListRecommendationsRequest extends GeneratedMessageV3 implements ListRecommendationsRequestOrBuilder

Request for the ListRecommendations method.

Protobuf type google.cloud.recommender.v1.ListRecommendationsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListRecommendationsRequest

Implements

ListRecommendationsRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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()

Returns

Type	Description
ListRecommendationsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static ListRecommendationsRequest.Builder newBuilder()

Returns

Type	Description
ListRecommendationsRequest.Builder

newBuilder(ListRecommendationsRequest prototype)

public static ListRecommendationsRequest.Builder newBuilder(ListRecommendationsRequest prototype)

Parameter

Name	Description
prototype	`ListRecommendationsRequest`

Returns

Type	Description
ListRecommendationsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListRecommendationsRequest parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	`InputStream`

Returns

Type	Description
ListRecommendationsRequest

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListRecommendationsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`InputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
ListRecommendationsRequest

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static ListRecommendationsRequest parseFrom(byte[] data)

Parameter

Name	Description
data	`byte[]`

Returns

Type	Description
ListRecommendationsRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListRecommendationsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	`byte[]`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
ListRecommendationsRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListRecommendationsRequest parseFrom(ByteString data)

Parameter

Name	Description
data	`ByteString`

Returns

Type	Description
ListRecommendationsRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListRecommendationsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	`ByteString`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
ListRecommendationsRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListRecommendationsRequest parseFrom(CodedInputStream input)

Parameter

Name	Description
input	`CodedInputStream`

Returns

Type	Description
ListRecommendationsRequest

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListRecommendationsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
ListRecommendationsRequest

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static ListRecommendationsRequest parseFrom(InputStream input)

Parameter

Name	Description
input	`InputStream`

Returns

Type	Description
ListRecommendationsRequest

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListRecommendationsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`InputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
ListRecommendationsRequest

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static ListRecommendationsRequest parseFrom(ByteBuffer data)

Parameter

Name	Description
data	`ByteBuffer`

Returns

Type	Description
ListRecommendationsRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListRecommendationsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	`ByteBuffer`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
ListRecommendationsRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ListRecommendationsRequest> parser()

Returns

Type	Description
Parser<ListRecommendationsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	`Object`

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public ListRecommendationsRequest getDefaultInstanceForType()

Returns

Type	Description
ListRecommendationsRequest

getFilter()

public String getFilter()

Filter expression to restrict the recommendations returned. Supported filter fields:

state_info.state
recommenderSubtype
priority Examples:
stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED
recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE
priority = P1 OR priority = P2
stateInfo.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.state
recommenderSubtype
priority Examples:
stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED
recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE
priority = P1 OR priority = P2
stateInfo.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()

public 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

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()

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()

Returns

Type	Description
Parser<ListRecommendationsRequest>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public ListRecommendationsRequest.Builder newBuilderForType()

Returns

Type	Description
ListRecommendationsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListRecommendationsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	`BuilderParent`

Returns

Type	Description
ListRecommendationsRequest.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	`UnusedPrivateParameter`

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public ListRecommendationsRequest.Builder toBuilder()

Returns

Type	Description
ListRecommendationsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException