Package com.google.cloud.compute.v1

Class ListNodesNodeGroupsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.compute.v1.ListNodesNodeGroupsRequest
All Implemented Interfaces:
ListNodesNodeGroupsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ListNodesNodeGroupsRequest extends com.google.protobuf.GeneratedMessage implements ListNodesNodeGroupsRequestOrBuilder
 A request message for NodeGroups.ListNodes. See the method description for details.
Protobuf type google.cloud.compute.v1.ListNodesNodeGroupsRequest
See Also:

  • Field Details

    • FILTER_FIELD_NUMBER

      public static final int FILTER_FIELD_NUMBER
      See Also:

    • MAX_RESULTS_FIELD_NUMBER

      public static final int MAX_RESULTS_FIELD_NUMBER
      See Also:

    • NODE_GROUP_FIELD_NUMBER

      public static final int NODE_GROUP_FIELD_NUMBER
      See Also:

    • ORDER_BY_FIELD_NUMBER

      public static final int ORDER_BY_FIELD_NUMBER
      See Also:

    • PAGE_TOKEN_FIELD_NUMBER

      public static final int PAGE_TOKEN_FIELD_NUMBER
      See Also:

    • PROJECT_FIELD_NUMBER

      public static final int PROJECT_FIELD_NUMBER
      See Also:

    • RETURN_PARTIAL_SUCCESS_FIELD_NUMBER

      public static final int RETURN_PARTIAL_SUCCESS_FIELD_NUMBER
      See Also:

    • ZONE_FIELD_NUMBER

      public static final int ZONE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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 onresource 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 GoogleRE2 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;
      Specified by:
      hasFilter in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      Whether the filter field is set.

    • 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 onresource 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 GoogleRE2 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;
      Specified by:
      getFilter in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.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 onresource 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 GoogleRE2 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;
      Specified by:
      getFilterBytes in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      The bytes for filter.

    • 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;
      Specified by:
      hasMaxResults in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      Whether the maxResults field is set.

    • 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;
      Specified by:
      getMaxResults in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      The maxResults.

    • getNodeGroup

      public String getNodeGroup()
       Name of the NodeGroup resource whose nodes you want to list.
      string node_group = 469958146 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNodeGroup in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      The nodeGroup.

    • getNodeGroupBytes

      public com.google.protobuf.ByteString getNodeGroupBytes()
       Name of the NodeGroup resource whose nodes you want to list.
      string node_group = 469958146 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNodeGroupBytes in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      The bytes for nodeGroup.

    • 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;
      Specified by:
      hasOrderBy in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      Whether the orderBy field is set.

    • 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;
      Specified by:
      getOrderBy in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public com.google.protobuf.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;
      Specified by:
      getOrderByBytes in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • 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;
      Specified by:
      hasPageToken in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      Whether the pageToken field is set.

    • 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;
      Specified by:
      getPageToken in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.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;
      Specified by:
      getPageTokenBytes in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getProject

      public String getProject()
       Project ID for this request.
      string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProject in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      The project.

    • getProjectBytes

      public com.google.protobuf.ByteString getProjectBytes()
       Project ID for this request.
      string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProjectBytes in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      The bytes for project.

    • hasReturnPartialSuccess

      public boolean hasReturnPartialSuccess()
       Opt-in for partial success behavior which provides partial results in case
 of failure. The default value is false.

 For example, when partial success behavior is enabled, aggregatedList for a
 single zone scope either returns all resources in the zone or no resources,
 with an error code.
      optional bool return_partial_success = 517198390;
      Specified by:
      hasReturnPartialSuccess in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      Whether the returnPartialSuccess field is set.

    • getReturnPartialSuccess

      public boolean getReturnPartialSuccess()
       Opt-in for partial success behavior which provides partial results in case
 of failure. The default value is false.

 For example, when partial success behavior is enabled, aggregatedList for a
 single zone scope either returns all resources in the zone or no resources,
 with an error code.
      optional bool return_partial_success = 517198390;
      Specified by:
      getReturnPartialSuccess in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      The returnPartialSuccess.

    • getZone

      public String getZone()
       The name of the zone for this request.
      string zone = 3744684 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getZone in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      The zone.

    • getZoneBytes

      public com.google.protobuf.ByteString getZoneBytes()
       The name of the zone for this request.
      string zone = 3744684 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getZoneBytes in interface ListNodesNodeGroupsRequestOrBuilder
      Returns:
      The bytes for zone.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ListNodesNodeGroupsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListNodesNodeGroupsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListNodesNodeGroupsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListNodesNodeGroupsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListNodesNodeGroupsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListNodesNodeGroupsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListNodesNodeGroupsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListNodesNodeGroupsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListNodesNodeGroupsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListNodesNodeGroupsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListNodesNodeGroupsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListNodesNodeGroupsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ListNodesNodeGroupsRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ListNodesNodeGroupsRequest.Builder newBuilder()

    • newBuilder

      public static ListNodesNodeGroupsRequest.Builder newBuilder(ListNodesNodeGroupsRequest prototype)

    • toBuilder

      public ListNodesNodeGroupsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ListNodesNodeGroupsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ListNodesNodeGroupsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListNodesNodeGroupsRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ListNodesNodeGroupsRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ListNodesNodeGroupsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder