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="cloudresourcemanager_v1.html">Google Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1.liens.html">liens</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
     79 <p class="firstline">Create a Lien which applies to the resource denoted by the `parent` field.</p>
     80 <p class="toc_element">
     81   <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
     82 <p class="firstline">Delete a Lien by `name`.</p>
     83 <p class="toc_element">
     84   <code><a href="#list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
     85 <p class="firstline">List all Liens applied to the `parent` resource.</p>
     86 <p class="toc_element">
     87   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     88 <p class="firstline">Retrieves the next page of results.</p>
     89 <h3>Method Details</h3>
     90 <div class="method">
     91     <code class="details" id="create">create(body, x__xgafv=None)</code>
     92   <pre>Create a Lien which applies to the resource denoted by the `parent` field.
     93 
     94 Callers of this method will require permission on the `parent` resource.
     95 For example, applying to `projects/1234` requires permission
     96 `resourcemanager.projects.updateLiens`.
     97 
     98 NOTE: Some resources may limit the number of Liens which may be applied.
     99 
    100 Args:
    101   body: object, The request body. (required)
    102     The object takes the form of:
    103 
    104 { # A Lien represents an encumbrance on the actions that can be performed on a
    105       # resource.
    106     "origin": "A String", # A stable, user-visible/meaningful string identifying the origin of the
    107         # Lien, intended to be inspected programmatically. Maximum length of 200
    108         # characters.
    109         # 
    110         # Example: 'compute.googleapis.com'
    111     "restrictions": [ # The types of operations which should be blocked as a result of this Lien.
    112         # Each value should correspond to an IAM permission. The server will
    113         # validate the permissions against those for which Liens are supported.
    114         # 
    115         # An empty list is meaningless and will be rejected.
    116         # 
    117         # Example: ['resourcemanager.projects.delete']
    118       "A String",
    119     ],
    120     "name": "A String", # A system-generated unique identifier for this Lien.
    121         # 
    122         # Example: `liens/1234abcd`
    123     "parent": "A String", # A reference to the resource this Lien is attached to. The server will
    124         # validate the parent against those for which Liens are supported.
    125         # 
    126         # Example: `projects/1234`
    127     "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed
    128         # on a resource. Maximum lenth of 200 characters.
    129         # 
    130         # Example: 'Holds production API key'
    131     "createTime": "A String", # The creation time of this Lien.
    132   }
    133 
    134   x__xgafv: string, V1 error format.
    135     Allowed values
    136       1 - v1 error format
    137       2 - v2 error format
    138 
    139 Returns:
    140   An object of the form:
    141 
    142     { # A Lien represents an encumbrance on the actions that can be performed on a
    143         # resource.
    144       "origin": "A String", # A stable, user-visible/meaningful string identifying the origin of the
    145           # Lien, intended to be inspected programmatically. Maximum length of 200
    146           # characters.
    147           #
    148           # Example: 'compute.googleapis.com'
    149       "restrictions": [ # The types of operations which should be blocked as a result of this Lien.
    150           # Each value should correspond to an IAM permission. The server will
    151           # validate the permissions against those for which Liens are supported.
    152           #
    153           # An empty list is meaningless and will be rejected.
    154           #
    155           # Example: ['resourcemanager.projects.delete']
    156         "A String",
    157       ],
    158       "name": "A String", # A system-generated unique identifier for this Lien.
    159           #
    160           # Example: `liens/1234abcd`
    161       "parent": "A String", # A reference to the resource this Lien is attached to. The server will
    162           # validate the parent against those for which Liens are supported.
    163           #
    164           # Example: `projects/1234`
    165       "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed
    166           # on a resource. Maximum lenth of 200 characters.
    167           #
    168           # Example: 'Holds production API key'
    169       "createTime": "A String", # The creation time of this Lien.
    170     }</pre>
    171 </div>
    172 
    173 <div class="method">
    174     <code class="details" id="delete">delete(name, x__xgafv=None)</code>
    175   <pre>Delete a Lien by `name`.
    176 
    177 Callers of this method will require permission on the `parent` resource.
    178 For example, a Lien with a `parent` of `projects/1234` requires permission
    179 `resourcemanager.projects.updateLiens`.
    180 
    181 Args:
    182   name: string, The name/identifier of the Lien to delete. (required)
    183   x__xgafv: string, V1 error format.
    184     Allowed values
    185       1 - v1 error format
    186       2 - v2 error format
    187 
    188 Returns:
    189   An object of the form:
    190 
    191     { # A generic empty message that you can re-use to avoid defining duplicated
    192       # empty messages in your APIs. A typical example is to use it as the request
    193       # or the response type of an API method. For instance:
    194       #
    195       #     service Foo {
    196       #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
    197       #     }
    198       #
    199       # The JSON representation for `Empty` is empty JSON object `{}`.
    200   }</pre>
    201 </div>
    202 
    203 <div class="method">
    204     <code class="details" id="list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
    205   <pre>List all Liens applied to the `parent` resource.
    206 
    207 Callers of this method will require permission on the `parent` resource.
    208 For example, a Lien with a `parent` of `projects/1234` requires permission
    209 `resourcemanager.projects.get`.
    210 
    211 Args:
    212   parent: string, The name of the resource to list all attached Liens.
    213 For example, `projects/1234`.
    214   pageSize: integer, The maximum number of items to return. This is a suggestion for the server.
    215   pageToken: string, The `next_page_token` value returned from a previous List request, if any.
    216   x__xgafv: string, V1 error format.
    217     Allowed values
    218       1 - v1 error format
    219       2 - v2 error format
    220 
    221 Returns:
    222   An object of the form:
    223 
    224     { # The response message for Liens.ListLiens.
    225     "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
    226         # results in the list.
    227     "liens": [ # A list of Liens.
    228       { # A Lien represents an encumbrance on the actions that can be performed on a
    229             # resource.
    230           "origin": "A String", # A stable, user-visible/meaningful string identifying the origin of the
    231               # Lien, intended to be inspected programmatically. Maximum length of 200
    232               # characters.
    233               #
    234               # Example: 'compute.googleapis.com'
    235           "restrictions": [ # The types of operations which should be blocked as a result of this Lien.
    236               # Each value should correspond to an IAM permission. The server will
    237               # validate the permissions against those for which Liens are supported.
    238               #
    239               # An empty list is meaningless and will be rejected.
    240               #
    241               # Example: ['resourcemanager.projects.delete']
    242             "A String",
    243           ],
    244           "name": "A String", # A system-generated unique identifier for this Lien.
    245               #
    246               # Example: `liens/1234abcd`
    247           "parent": "A String", # A reference to the resource this Lien is attached to. The server will
    248               # validate the parent against those for which Liens are supported.
    249               #
    250               # Example: `projects/1234`
    251           "reason": "A String", # Concise user-visible strings indicating why an action cannot be performed
    252               # on a resource. Maximum lenth of 200 characters.
    253               #
    254               # Example: 'Holds production API key'
    255           "createTime": "A String", # The creation time of this Lien.
    256         },
    257     ],
    258   }</pre>
    259 </div>
    260 
    261 <div class="method">
    262     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    263   <pre>Retrieves the next page of results.
    264 
    265 Args:
    266   previous_request: The request for the previous page. (required)
    267   previous_response: The response from the request for the previous page. (required)
    268 
    269 Returns:
    270   A request object that you can call 'execute()' on to request the next
    271   page. Returns None if there are no more items in the collection.
    272     </pre>
    273 </div>
    274 
    275 </body></html>