All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • target.apidocs.com.google.api.services.compute.Compute.Routers.GetNatMappingInfo.html Maven / Gradle / Ivy

    There is a newer version: v1-rev20250320-2.0.0
    Show newest version
    





Compute.Routers.GetNatMappingInfo (Compute Engine API v1-rev20250107-2.0.0)









    



    Skip navigation links
    





    

    




    


    

    



    



    



    

    com.google.api.services.compute
    

    Class Compute.Routers.GetNatMappingInfo
    

    

    


    


    

    


    

    

      

    • 


        

      • 



        Constructor Detail
        




          

        • 

          GetNatMappingInfo
          

          protected GetNatMappingInfo(String project,
                            String region,
                            String router)
          

          Retrieves runtime Nat mapping information of VM endpoints.

 Create a request for the method "routers.getNatMappingInfo".

 This request holds the parameters needed by the the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
 
           GetNatMappingInfo#initialize(com.google.api.client.googleapis.services.AbstractGoogl
 eClientRequest) must be called to initialize this instance immediately after invoking the
 constructor. 
          

          

          Parameters:
          

          project - Project ID for this request.
          

          region - Name of the region for this request.
          

          router - Name of the Router resource to query for Nat Mapping information of VM endpoints.
          

          Since:
          

          1.13
          

          

          • 

        

        • 

      


        

      • 



        Method Detail
        




          

        • 

          executeUsingHead
          

          public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
          

          

          Overrides:
          

          executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<VmEndpointNatMappingsList>
          

          Throws:
          

          IOException
          

          

          • 

        




          

        • 

          buildHttpRequestUsingHead
          

          public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
          

          

          Overrides:
          

          buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<VmEndpointNatMappingsList>
          

          Throws:
          

          IOException
          

          

          • 

        




















































          

        • 

          getProject
          

          public String getProject()
          

          Project ID for this request.
          

          • 

        








          

        • 

          getRegion
          

          public String getRegion()
          

          Name of the region for this request.
          

          • 

        








          

        • 

          getRouter
          

          public String getRouter()
          

          Name of the Router resource to query for Nat Mapping information of VM endpoints.
          

          • 

        








          

        • 

          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.
          

          • 

        




          

        • 

          setFilter
          

          public Compute.Routers.GetNatMappingInfo setFilter(String filter)
          

          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.
          

          • 

        




          

        • 

          getMaxResults
          

          public Long 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`) [default: 500] [minimum: 0]
          

          • 

        




          

        • 

          setMaxResults
          

          public Compute.Routers.GetNatMappingInfo setMaxResults(Long maxResults)
          

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

          • 

        




          

        • 

          getNatName
          

          public String getNatName()
          

          Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this
     router will be returned. Name should conform to RFC1035.
          

          • 

        




          

        • 

          setNatName
          

          public Compute.Routers.GetNatMappingInfo setNatName(String natName)
          

          Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats
 for this router will be returned. Name should conform to RFC1035.
          

          • 

        




          

        • 

          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.
          

          • 

        




          

        • 

          setOrderBy
          

          public Compute.Routers.GetNatMappingInfo setOrderBy(String orderBy)
          

          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.
          

          • 

        




          

        • 

          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.
          

          • 

        




          

        • 

          setPageToken
          

          public Compute.Routers.GetNatMappingInfo setPageToken(String pageToken)
          

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

          • 

        




          

        • 

          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.
          

          • 

        




          

        • 

          setReturnPartialSuccess
          

          public Compute.Routers.GetNatMappingInfo setReturnPartialSuccess(Boolean returnPartialSuccess)
          

          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.
          

          • 

        





        • 

      

      • 

    

    

    



    



    Skip navigation links
    





    

    




    


    

    



    



    


    Copyright © 2011–2025 Google. All rights reserved.




    © 2015 - 2025 Weber Informatics LLC | Privacy Policy