Class AggregatedListNodeGroupsRequest (1.46.0)

public final class AggregatedListNodeGroupsRequest extends GeneratedMessageV3 implements AggregatedListNodeGroupsRequestOrBuilder

A request message for NodeGroups.AggregatedList. See the method description for details.

Protobuf type google.cloud.compute.v1.AggregatedListNodeGroupsRequest

Inheritance

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

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

INCLUDE_ALL_SCOPES_FIELD_NUMBER

public static final int INCLUDE_ALL_SCOPES_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_RESULTS_FIELD_NUMBER

public static final int MAX_RESULTS_FIELD_NUMBER
Field Value
TypeDescription
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_FIELD_NUMBER

public static final int PROJECT_FIELD_NUMBER
Field Value
TypeDescription
int

RETURN_PARTIAL_SUCCESS_FIELD_NUMBER

public static final int RETURN_PARTIAL_SUCCESS_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_PROJECT_NUMBER_FIELD_NUMBER

public static final int SERVICE_PROJECT_NUMBER_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AggregatedListNodeGroupsRequest getDefaultInstance()
Returns
TypeDescription
AggregatedListNodeGroupsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AggregatedListNodeGroupsRequest.Builder newBuilder()
Returns
TypeDescription
AggregatedListNodeGroupsRequest.Builder

newBuilder(AggregatedListNodeGroupsRequest prototype)

public static AggregatedListNodeGroupsRequest.Builder newBuilder(AggregatedListNodeGroupsRequest prototype)
Parameter
NameDescription
prototypeAggregatedListNodeGroupsRequest
Returns
TypeDescription
AggregatedListNodeGroupsRequest.Builder

parseDelimitedFrom(InputStream input)

public static AggregatedListNodeGroupsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AggregatedListNodeGroupsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregatedListNodeGroupsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AggregatedListNodeGroupsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AggregatedListNodeGroupsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AggregatedListNodeGroupsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AggregatedListNodeGroupsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AggregatedListNodeGroupsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AggregatedListNodeGroupsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AggregatedListNodeGroupsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AggregatedListNodeGroupsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AggregatedListNodeGroupsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AggregatedListNodeGroupsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AggregatedListNodeGroupsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregatedListNodeGroupsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AggregatedListNodeGroupsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AggregatedListNodeGroupsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AggregatedListNodeGroupsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregatedListNodeGroupsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AggregatedListNodeGroupsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AggregatedListNodeGroupsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AggregatedListNodeGroupsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AggregatedListNodeGroupsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AggregatedListNodeGroupsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AggregatedListNodeGroupsRequest> parser()
Returns
TypeDescription
Parser<AggregatedListNodeGroupsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public AggregatedListNodeGroupsRequest getDefaultInstanceForType()
Returns
TypeDescription
AggregatedListNodeGroupsRequest

getFilter()

public String getFilter()

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The : comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: ` labels.owner: You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

optional string filter = 336120696;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The : comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: ` labels.owner: You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

optional string filter = 336120696;

Returns
TypeDescription
ByteString

The bytes for filter.

getIncludeAllScopes()

public boolean getIncludeAllScopes()

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

optional bool include_all_scopes = 391327988;

Returns
TypeDescription
boolean

The includeAllScopes.

getMaxResults()

public int getMaxResults()

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

optional uint32 max_results = 54715419;

Returns
TypeDescription
int

The maxResults.

getOrderBy()

public String getOrderBy()

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

optional string order_by = 160562920;

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

optional string order_by = 160562920;

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageToken()

public String getPageToken()

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

optional string page_token = 19994697;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

optional string page_token = 19994697;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParserForType()

public Parser<AggregatedListNodeGroupsRequest> getParserForType()
Returns
TypeDescription
Parser<AggregatedListNodeGroupsRequest>
Overrides

getProject()

public String getProject()

Project ID for this request.

string project = 227560217 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The project.

getProjectBytes()

public ByteString getProjectBytes()

Project ID for this request.

string project = 227560217 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for project.

getReturnPartialSuccess()

public boolean getReturnPartialSuccess()

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

optional bool return_partial_success = 517198390;

Returns
TypeDescription
boolean

The returnPartialSuccess.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getServiceProjectNumber()

public long getServiceProjectNumber()

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

optional int64 service_project_number = 316757497;

Returns
TypeDescription
long

The serviceProjectNumber.

hasFilter()

public boolean hasFilter()

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The : comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: ` labels.owner: You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

optional string filter = 336120696;

Returns
TypeDescription
boolean

Whether the filter field is set.

hasIncludeAllScopes()

public boolean hasIncludeAllScopes()

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

optional bool include_all_scopes = 391327988;

Returns
TypeDescription
boolean

Whether the includeAllScopes field is set.

hasMaxResults()

public boolean hasMaxResults()

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

optional uint32 max_results = 54715419;

Returns
TypeDescription
boolean

Whether the maxResults field is set.

hasOrderBy()

public boolean hasOrderBy()

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

optional string order_by = 160562920;

Returns
TypeDescription
boolean

Whether the orderBy field is set.

hasPageToken()

public boolean hasPageToken()

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

optional string page_token = 19994697;

Returns
TypeDescription
boolean

Whether the pageToken field is set.

hasReturnPartialSuccess()

public boolean hasReturnPartialSuccess()

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

optional bool return_partial_success = 517198390;

Returns
TypeDescription
boolean

Whether the returnPartialSuccess field is set.

hasServiceProjectNumber()

public boolean hasServiceProjectNumber()

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

optional int64 service_project_number = 316757497;

Returns
TypeDescription
boolean

Whether the serviceProjectNumber field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AggregatedListNodeGroupsRequest.Builder newBuilderForType()
Returns
TypeDescription
AggregatedListNodeGroupsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AggregatedListNodeGroupsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AggregatedListNodeGroupsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AggregatedListNodeGroupsRequest.Builder toBuilder()
Returns
TypeDescription
AggregatedListNodeGroupsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException