1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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="accesscontextmanager_v1beta.html">Access Context Manager API</a> . <a href="accesscontextmanager_v1beta.accessPolicies.html">accessPolicies</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="accesscontextmanager_v1beta.accessPolicies.accessLevels.html">accessLevels()</a></code> 79</p> 80<p class="firstline">Returns the accessLevels Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="accesscontextmanager_v1beta.accessPolicies.servicePerimeters.html">servicePerimeters()</a></code> 84</p> 85<p class="firstline">Returns the servicePerimeters Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="#close">close()</a></code></p> 89<p class="firstline">Close httplib2 connections.</p> 90<p class="toc_element"> 91 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p> 92<p class="firstline">Create an `AccessPolicy`. Fails if this organization already has a `AccessPolicy`. The longrunning Operation will have a successful status once the `AccessPolicy` has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.</p> 93<p class="toc_element"> 94 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 95<p class="firstline">Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage.</p> 96<p class="toc_element"> 97 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 98<p class="firstline">Get an AccessPolicy by name.</p> 99<p class="toc_element"> 100 <code><a href="#list">list(pageSize=None, pageToken=None, parent=None, x__xgafv=None)</a></code></p> 101<p class="firstline">List all AccessPolicies under a container.</p> 102<p class="toc_element"> 103 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 104<p class="firstline">Retrieves the next page of results.</p> 105<p class="toc_element"> 106 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 107<p class="firstline">Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.</p> 108<h3>Method Details</h3> 109<div class="method"> 110 <code class="details" id="close">close()</code> 111 <pre>Close httplib2 connections.</pre> 112</div> 113 114<div class="method"> 115 <code class="details" id="create">create(body=None, x__xgafv=None)</code> 116 <pre>Create an `AccessPolicy`. Fails if this organization already has a `AccessPolicy`. The longrunning Operation will have a successful status once the `AccessPolicy` has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto. 117 118Args: 119 body: object, The request body. 120 The object takes the form of: 121 122{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. 123 "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}` 124 "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` 125 "title": "A String", # Required. Human readable title. Does not affect behavior. 126} 127 128 x__xgafv: string, V1 error format. 129 Allowed values 130 1 - v1 error format 131 2 - v2 error format 132 133Returns: 134 An object of the form: 135 136 { # This resource represents a long-running operation that is the result of a network API call. 137 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 138 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 139 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 140 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 141 { 142 "a_key": "", # Properties of the object. Contains field @type with type URL. 143 }, 144 ], 145 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 146 }, 147 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 148 "a_key": "", # Properties of the object. Contains field @type with type URL. 149 }, 150 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 151 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 152 "a_key": "", # Properties of the object. Contains field @type with type URL. 153 }, 154}</pre> 155</div> 156 157<div class="method"> 158 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 159 <pre>Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage. 160 161Args: 162 name: string, Required. Resource name for the access policy to delete. Format `accessPolicies/{policy_id}` (required) 163 x__xgafv: string, V1 error format. 164 Allowed values 165 1 - v1 error format 166 2 - v2 error format 167 168Returns: 169 An object of the form: 170 171 { # This resource represents a long-running operation that is the result of a network API call. 172 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 173 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 174 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 175 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 176 { 177 "a_key": "", # Properties of the object. Contains field @type with type URL. 178 }, 179 ], 180 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 181 }, 182 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 183 "a_key": "", # Properties of the object. Contains field @type with type URL. 184 }, 185 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 186 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 187 "a_key": "", # Properties of the object. Contains field @type with type URL. 188 }, 189}</pre> 190</div> 191 192<div class="method"> 193 <code class="details" id="get">get(name, x__xgafv=None)</code> 194 <pre>Get an AccessPolicy by name. 195 196Args: 197 name: string, Required. Resource name for the access policy to get. Format `accessPolicies/{policy_id}` (required) 198 x__xgafv: string, V1 error format. 199 Allowed values 200 1 - v1 error format 201 2 - v2 error format 202 203Returns: 204 An object of the form: 205 206 { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. 207 "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}` 208 "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` 209 "title": "A String", # Required. Human readable title. Does not affect behavior. 210}</pre> 211</div> 212 213<div class="method"> 214 <code class="details" id="list">list(pageSize=None, pageToken=None, parent=None, x__xgafv=None)</code> 215 <pre>List all AccessPolicies under a container. 216 217Args: 218 pageSize: integer, Number of AccessPolicy instances to include in the list. Default 100. 219 pageToken: string, Next page token for the next batch of AccessPolicy instances. Defaults to the first page of results. 220 parent: string, Required. Resource name for the container to list AccessPolicy instances from. Format: `organizations/{org_id}` 221 x__xgafv: string, V1 error format. 222 Allowed values 223 1 - v1 error format 224 2 - v2 error format 225 226Returns: 227 An object of the form: 228 229 { # A response to `ListAccessPoliciesRequest`. 230 "accessPolicies": [ # List of the AccessPolicy instances. 231 { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. 232 "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}` 233 "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` 234 "title": "A String", # Required. Human readable title. Does not affect behavior. 235 }, 236 ], 237 "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is empty, no further results remain. 238}</pre> 239</div> 240 241<div class="method"> 242 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 243 <pre>Retrieves the next page of results. 244 245Args: 246 previous_request: The request for the previous page. (required) 247 previous_response: The response from the request for the previous page. (required) 248 249Returns: 250 A request object that you can call 'execute()' on to request the next 251 page. Returns None if there are no more items in the collection. 252 </pre> 253</div> 254 255<div class="method"> 256 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 257 <pre>Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto. 258 259Args: 260 name: string, Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}` (required) 261 body: object, The request body. 262 The object takes the form of: 263 264{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. 265 "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}` 266 "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` 267 "title": "A String", # Required. Human readable title. Does not affect behavior. 268} 269 270 updateMask: string, Required. Mask to control which fields get updated. Must be non-empty. 271 x__xgafv: string, V1 error format. 272 Allowed values 273 1 - v1 error format 274 2 - v2 error format 275 276Returns: 277 An object of the form: 278 279 { # This resource represents a long-running operation that is the result of a network API call. 280 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 281 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 282 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 283 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 284 { 285 "a_key": "", # Properties of the object. Contains field @type with type URL. 286 }, 287 ], 288 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 289 }, 290 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 291 "a_key": "", # Properties of the object. Contains field @type with type URL. 292 }, 293 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 294 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 295 "a_key": "", # Properties of the object. Contains field @type with type URL. 296 }, 297}</pre> 298</div> 299 300</body></html>