Home | History | Annotate | Download | only in dyn
      1 <html><body>
      2 <style>
      3 
      4 body, h1, h2, h3, div, span, p, pre, a {
      5   margin: 0;
      6   padding: 0;
      7   border: 0;
      8   font-weight: inherit;
      9   font-style: inherit;
     10   font-size: 100%;
     11   font-family: inherit;
     12   vertical-align: baseline;
     13 }
     14 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, h2, h3 {
     50   border-bottom: solid #CCC 1px;
     51 }
     52 
     53 .toc_element {
     54   margin-top: 0.5em;
     55 }
     56 
     57 .firstline {
     58   margin-left: 2 em;
     59 }
     60 
     61 .method  {
     62   margin-top: 1em;
     63   border: solid 1px #CCC;
     64   padding: 1em;
     65   background: #EEE;
     66 }
     67 
     68 .details {
     69   font-weight: bold;
     70   font-size: 14px;
     71 }
     72 
     73 </style>
     74 
     75 <h1><a href="cloudkms_v1.html">Google Cloud Key Management Service (KMS) API</a> . <a href="cloudkms_v1.projects.html">projects</a> . <a href="cloudkms_v1.projects.locations.html">locations</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="cloudkms_v1.projects.locations.keyRings.html">keyRings()</a></code>
     79 </p>
     80 <p class="firstline">Returns the keyRings Resource.</p>
     81 
     82 <p class="toc_element">
     83   <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
     84 <p class="firstline">Get information about a location.</p>
     85 <p class="toc_element">
     86   <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
     87 <p class="firstline">Lists information about the supported locations for this service.</p>
     88 <p class="toc_element">
     89   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     90 <p class="firstline">Retrieves the next page of results.</p>
     91 <h3>Method Details</h3>
     92 <div class="method">
     93     <code class="details" id="get">get(name, x__xgafv=None)</code>
     94   <pre>Get information about a location.
     95 
     96 Args:
     97   name: string, Resource name for the location. (required)
     98   x__xgafv: string, V1 error format.
     99     Allowed values
    100       1 - v1 error format
    101       2 - v2 error format
    102 
    103 Returns:
    104   An object of the form:
    105 
    106     { # A resource that represents Google Cloud Platform location.
    107     "labels": { # Cross-service attributes for the location. For example
    108         #
    109         #     {"cloud.googleapis.com/region": "us-east1"}
    110       "a_key": "A String",
    111     },
    112     "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
    113     "name": "A String", # Resource name for the location, which may vary between implementations.
    114         # For example: `"projects/example-project/locations/us-east1"`
    115     "metadata": { # Service-specific metadata. For example the available capacity at the given
    116         # location.
    117       "a_key": "", # Properties of the object. Contains field @type with type URL.
    118     },
    119   }</pre>
    120 </div>
    121 
    122 <div class="method">
    123     <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
    124   <pre>Lists information about the supported locations for this service.
    125 
    126 Args:
    127   name: string, The resource that owns the locations collection, if applicable. (required)
    128   pageSize: integer, The standard list page size.
    129   filter: string, The standard list filter.
    130   pageToken: string, The standard list page token.
    131   x__xgafv: string, V1 error format.
    132     Allowed values
    133       1 - v1 error format
    134       2 - v2 error format
    135 
    136 Returns:
    137   An object of the form:
    138 
    139     { # The response message for Locations.ListLocations.
    140     "nextPageToken": "A String", # The standard List next-page token.
    141     "locations": [ # A list of locations that matches the specified filter in the request.
    142       { # A resource that represents Google Cloud Platform location.
    143         "labels": { # Cross-service attributes for the location. For example
    144             #
    145             #     {"cloud.googleapis.com/region": "us-east1"}
    146           "a_key": "A String",
    147         },
    148         "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
    149         "name": "A String", # Resource name for the location, which may vary between implementations.
    150             # For example: `"projects/example-project/locations/us-east1"`
    151         "metadata": { # Service-specific metadata. For example the available capacity at the given
    152             # location.
    153           "a_key": "", # Properties of the object. Contains field @type with type URL.
    154         },
    155       },
    156     ],
    157   }</pre>
    158 </div>
    159 
    160 <div class="method">
    161     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    162   <pre>Retrieves the next page of results.
    163 
    164 Args:
    165   previous_request: The request for the previous page. (required)
    166   previous_response: The response from the request for the previous page. (required)
    167 
    168 Returns:
    169   A request object that you can call 'execute()' on to request the next
    170   page. Returns None if there are no more items in the collection.
    171     </pre>
    172 </div>
    173 
    174 </body></html>