docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/accesscontextmanager_v1beta.accessPolicies.servicePerimeters.html b/docs/dyn/accesscontextmanager_v1beta.accessPolicies.servicePerimeters.html
index e37e5be..29ad9d8 100644
--- a/docs/dyn/accesscontextmanager_v1beta.accessPolicies.servicePerimeters.html
+++ b/docs/dyn/accesscontextmanager_v1beta.accessPolicies.servicePerimeters.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a Service Perimeter by resource</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all Service Perimeters for an</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -110,69 +110,69 @@
The object takes the form of:
{ # `ServicePerimeter` describes a set of Google Cloud resources which can freely
- # import and export data amongst themselves, but not export outside of the
- # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
- # has a target outside of the `ServicePerimeter`, the request will be blocked.
- # Otherwise the request is allowed. There are two types of Service Perimeter -
- # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
- # Google Cloud project can only belong to a single regular Service Perimeter.
- # Service Perimeter Bridges can contain only Google Cloud projects as members,
- # a single Google Cloud project may belong to multiple Service Perimeter
- # Bridges.
- "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
- # restricted/unrestricted services and access levels that determine perimeter
- # content and boundaries.
- # describe specific Service Perimeter configuration.
- "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
- # restrictions. Must contain a list of services. For example, if
- # `storage.googleapis.com` is specified, access to the storage buckets
- # inside the perimeter must meet the perimeter's access restrictions.
- "A String",
+ # import and export data amongst themselves, but not export outside of the
+ # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
+ # has a target outside of the `ServicePerimeter`, the request will be blocked.
+ # Otherwise the request is allowed. There are two types of Service Perimeter -
+ # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
+ # Google Cloud project can only belong to a single regular Service Perimeter.
+ # Service Perimeter Bridges can contain only Google Cloud projects as members,
+ # a single Google Cloud project may belong to multiple Service Perimeter
+ # Bridges.
+ "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`
+ # component must begin with a letter and only include alphanumeric and '_'.
+ # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
+ "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
+ # behavior.
+ "perimeterType": "A String", # Perimeter type indicator. A single project is
+ # allowed to be a member of single regular perimeter, but multiple service
+ # perimeter bridges. A project cannot be a included in a perimeter bridge
+ # without being included in regular perimeter. For perimeter bridges,
+ # restricted/unrestricted service lists as well as access lists must be
+ # empty.
+ "title": "A String", # Human readable title. Must be unique within the Policy.
+ "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
+ # restricted/unrestricted services and access levels that determine perimeter
+ # content and boundaries.
+ # describe specific Service Perimeter configuration.
+ "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
+ # Currently only projects are allowed. Format: `projects/{project_number}`
+ "A String",
+ ],
+ "unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter
+ # restrictions. Deprecated. Must be set to a single wildcard "*".
+ #
+ # The wildcard means that unless explicitly specified by
+ # "restricted_services" list, any service is treated as unrestricted.
+ "A String",
+ ],
+ "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
+ # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
+ # must be in the same policy as this `ServicePerimeter`. Referencing a
+ # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
+ # listed, resources within the perimeter can only be accessed via Google
+ # Cloud calls with request origins within the perimeter. Example:
+ # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
+ # For Service Perimeter Bridge, must be empty.
+ "A String",
+ ],
+ "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
+ # restrictions. Must contain a list of services. For example, if
+ # `storage.googleapis.com` is specified, access to the storage buckets
+ # inside the perimeter must meet the perimeter's access restrictions.
+ "A String",
+ ],
+ "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
+ # Perimeter.
+ "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
+ # unless 'enable_restriction' is True.
+ "A String",
],
- "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
- # Perimeter.
- "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
- # APIs specified in 'allowed_services'.
- "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
- # unless 'enable_restriction' is True.
- "A String",
- ],
- },
- "unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter
- # restrictions. Deprecated. Must be set to a single wildcard "*".
- #
- # The wildcard means that unless explicitly specified by
- # "restricted_services" list, any service is treated as unrestricted.
- "A String",
- ],
- "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
- # Currently only projects are allowed. Format: `projects/{project_number}`
- "A String",
- ],
- "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
- # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
- # must be in the same policy as this `ServicePerimeter`. Referencing a
- # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
- # listed, resources within the perimeter can only be accessed via Google
- # Cloud calls with request origins within the perimeter. Example:
- # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
- # For Service Perimeter Bridge, must be empty.
- "A String",
- ],
+ "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
+ # APIs specified in 'allowed_services'.
},
- "title": "A String", # Human readable title. Must be unique within the Policy.
- "perimeterType": "A String", # Perimeter type indicator. A single project is
- # allowed to be a member of single regular perimeter, but multiple service
- # perimeter bridges. A project cannot be a included in a perimeter bridge
- # without being included in regular perimeter. For perimeter bridges,
- # restricted/unrestricted service lists as well as access lists must be
- # empty.
- "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`
- # component must begin with a letter and only include alphanumeric and '_'.
- # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
- "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
- # behavior.
- }
+ },
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -184,34 +184,7 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "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.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
@@ -219,11 +192,38 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
}</pre>
</div>
@@ -249,34 +249,7 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "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.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
@@ -284,11 +257,38 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
}</pre>
</div>
@@ -311,73 +311,73 @@
An object of the form:
{ # `ServicePerimeter` describes a set of Google Cloud resources which can freely
- # import and export data amongst themselves, but not export outside of the
- # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
- # has a target outside of the `ServicePerimeter`, the request will be blocked.
- # Otherwise the request is allowed. There are two types of Service Perimeter -
- # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
- # Google Cloud project can only belong to a single regular Service Perimeter.
- # Service Perimeter Bridges can contain only Google Cloud projects as members,
- # a single Google Cloud project may belong to multiple Service Perimeter
- # Bridges.
- "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
- # restricted/unrestricted services and access levels that determine perimeter
- # content and boundaries.
- # describe specific Service Perimeter configuration.
- "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
- # restrictions. Must contain a list of services. For example, if
- # `storage.googleapis.com` is specified, access to the storage buckets
- # inside the perimeter must meet the perimeter's access restrictions.
- "A String",
+ # import and export data amongst themselves, but not export outside of the
+ # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
+ # has a target outside of the `ServicePerimeter`, the request will be blocked.
+ # Otherwise the request is allowed. There are two types of Service Perimeter -
+ # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
+ # Google Cloud project can only belong to a single regular Service Perimeter.
+ # Service Perimeter Bridges can contain only Google Cloud projects as members,
+ # a single Google Cloud project may belong to multiple Service Perimeter
+ # Bridges.
+ "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`
+ # component must begin with a letter and only include alphanumeric and '_'.
+ # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
+ "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
+ # behavior.
+ "perimeterType": "A String", # Perimeter type indicator. A single project is
+ # allowed to be a member of single regular perimeter, but multiple service
+ # perimeter bridges. A project cannot be a included in a perimeter bridge
+ # without being included in regular perimeter. For perimeter bridges,
+ # restricted/unrestricted service lists as well as access lists must be
+ # empty.
+ "title": "A String", # Human readable title. Must be unique within the Policy.
+ "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
+ # restricted/unrestricted services and access levels that determine perimeter
+ # content and boundaries.
+ # describe specific Service Perimeter configuration.
+ "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
+ # Currently only projects are allowed. Format: `projects/{project_number}`
+ "A String",
+ ],
+ "unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter
+ # restrictions. Deprecated. Must be set to a single wildcard "*".
+ #
+ # The wildcard means that unless explicitly specified by
+ # "restricted_services" list, any service is treated as unrestricted.
+ "A String",
+ ],
+ "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
+ # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
+ # must be in the same policy as this `ServicePerimeter`. Referencing a
+ # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
+ # listed, resources within the perimeter can only be accessed via Google
+ # Cloud calls with request origins within the perimeter. Example:
+ # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
+ # For Service Perimeter Bridge, must be empty.
+ "A String",
+ ],
+ "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
+ # restrictions. Must contain a list of services. For example, if
+ # `storage.googleapis.com` is specified, access to the storage buckets
+ # inside the perimeter must meet the perimeter's access restrictions.
+ "A String",
+ ],
+ "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
+ # Perimeter.
+ "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
+ # unless 'enable_restriction' is True.
+ "A String",
],
- "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
- # Perimeter.
- "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
- # APIs specified in 'allowed_services'.
- "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
- # unless 'enable_restriction' is True.
- "A String",
- ],
- },
- "unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter
- # restrictions. Deprecated. Must be set to a single wildcard "*".
- #
- # The wildcard means that unless explicitly specified by
- # "restricted_services" list, any service is treated as unrestricted.
- "A String",
- ],
- "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
- # Currently only projects are allowed. Format: `projects/{project_number}`
- "A String",
- ],
- "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
- # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
- # must be in the same policy as this `ServicePerimeter`. Referencing a
- # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
- # listed, resources within the perimeter can only be accessed via Google
- # Cloud calls with request origins within the perimeter. Example:
- # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
- # For Service Perimeter Bridge, must be empty.
- "A String",
- ],
+ "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
+ # APIs specified in 'allowed_services'.
},
- "title": "A String", # Human readable title. Must be unique within the Policy.
- "perimeterType": "A String", # Perimeter type indicator. A single project is
- # allowed to be a member of single regular perimeter, but multiple service
- # perimeter bridges. A project cannot be a included in a perimeter bridge
- # without being included in regular perimeter. For perimeter bridges,
- # restricted/unrestricted service lists as well as access lists must be
- # empty.
- "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`
- # component must begin with a letter and only include alphanumeric and '_'.
- # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
- "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
- # behavior.
- }</pre>
+ },
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>List all Service Perimeters for an
access policy.
@@ -386,10 +386,10 @@
Format:
`accessPolicies/{policy_id}` (required)
- pageSize: integer, Number of Service Perimeters to include
-in the list. Default 100.
pageToken: string, Next page token for the next batch of Service Perimeter instances.
Defaults to the first page of results.
+ pageSize: integer, Number of Service Perimeters to include
+in the list. Default 100.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -399,74 +399,74 @@
An object of the form:
{ # A response to `ListServicePerimetersRequest`.
- "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
- # empty, no further results remain.
- "servicePerimeters": [ # List of the Service Perimeter instances.
+ "servicePerimeters": [ # List of the Service Perimeter instances.
{ # `ServicePerimeter` describes a set of Google Cloud resources which can freely
- # import and export data amongst themselves, but not export outside of the
- # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
- # has a target outside of the `ServicePerimeter`, the request will be blocked.
- # Otherwise the request is allowed. There are two types of Service Perimeter -
- # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
- # Google Cloud project can only belong to a single regular Service Perimeter.
- # Service Perimeter Bridges can contain only Google Cloud projects as members,
- # a single Google Cloud project may belong to multiple Service Perimeter
- # Bridges.
- "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
- # restricted/unrestricted services and access levels that determine perimeter
- # content and boundaries.
- # describe specific Service Perimeter configuration.
- "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
- # restrictions. Must contain a list of services. For example, if
- # `storage.googleapis.com` is specified, access to the storage buckets
- # inside the perimeter must meet the perimeter's access restrictions.
- "A String",
+ # import and export data amongst themselves, but not export outside of the
+ # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
+ # has a target outside of the `ServicePerimeter`, the request will be blocked.
+ # Otherwise the request is allowed. There are two types of Service Perimeter -
+ # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
+ # Google Cloud project can only belong to a single regular Service Perimeter.
+ # Service Perimeter Bridges can contain only Google Cloud projects as members,
+ # a single Google Cloud project may belong to multiple Service Perimeter
+ # Bridges.
+ "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`
+ # component must begin with a letter and only include alphanumeric and '_'.
+ # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
+ "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
+ # behavior.
+ "perimeterType": "A String", # Perimeter type indicator. A single project is
+ # allowed to be a member of single regular perimeter, but multiple service
+ # perimeter bridges. A project cannot be a included in a perimeter bridge
+ # without being included in regular perimeter. For perimeter bridges,
+ # restricted/unrestricted service lists as well as access lists must be
+ # empty.
+ "title": "A String", # Human readable title. Must be unique within the Policy.
+ "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
+ # restricted/unrestricted services and access levels that determine perimeter
+ # content and boundaries.
+ # describe specific Service Perimeter configuration.
+ "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
+ # Currently only projects are allowed. Format: `projects/{project_number}`
+ "A String",
+ ],
+ "unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter
+ # restrictions. Deprecated. Must be set to a single wildcard "*".
+ #
+ # The wildcard means that unless explicitly specified by
+ # "restricted_services" list, any service is treated as unrestricted.
+ "A String",
+ ],
+ "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
+ # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
+ # must be in the same policy as this `ServicePerimeter`. Referencing a
+ # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
+ # listed, resources within the perimeter can only be accessed via Google
+ # Cloud calls with request origins within the perimeter. Example:
+ # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
+ # For Service Perimeter Bridge, must be empty.
+ "A String",
+ ],
+ "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
+ # restrictions. Must contain a list of services. For example, if
+ # `storage.googleapis.com` is specified, access to the storage buckets
+ # inside the perimeter must meet the perimeter's access restrictions.
+ "A String",
+ ],
+ "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
+ # Perimeter.
+ "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
+ # unless 'enable_restriction' is True.
+ "A String",
],
- "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
- # Perimeter.
- "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
- # APIs specified in 'allowed_services'.
- "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
- # unless 'enable_restriction' is True.
- "A String",
- ],
- },
- "unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter
- # restrictions. Deprecated. Must be set to a single wildcard "*".
- #
- # The wildcard means that unless explicitly specified by
- # "restricted_services" list, any service is treated as unrestricted.
- "A String",
- ],
- "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
- # Currently only projects are allowed. Format: `projects/{project_number}`
- "A String",
- ],
- "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
- # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
- # must be in the same policy as this `ServicePerimeter`. Referencing a
- # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
- # listed, resources within the perimeter can only be accessed via Google
- # Cloud calls with request origins within the perimeter. Example:
- # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
- # For Service Perimeter Bridge, must be empty.
- "A String",
- ],
+ "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
+ # APIs specified in 'allowed_services'.
},
- "title": "A String", # Human readable title. Must be unique within the Policy.
- "perimeterType": "A String", # Perimeter type indicator. A single project is
- # allowed to be a member of single regular perimeter, but multiple service
- # perimeter bridges. A project cannot be a included in a perimeter bridge
- # without being included in regular perimeter. For perimeter bridges,
- # restricted/unrestricted service lists as well as access lists must be
- # empty.
- "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`
- # component must begin with a letter and only include alphanumeric and '_'.
- # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
- "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
- # behavior.
},
+ },
],
+ "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
+ # empty, no further results remain.
}</pre>
</div>
@@ -479,7 +479,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -494,75 +494,75 @@
Args:
name: string, Required. Resource name for the ServicePerimeter. The `short_name`
-component must begin with a letter and only include alphanumeric and '_'.
+component must begin with a letter and only include alphanumeric and '_'.
Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` (required)
body: object, The request body.
The object takes the form of:
{ # `ServicePerimeter` describes a set of Google Cloud resources which can freely
- # import and export data amongst themselves, but not export outside of the
- # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
- # has a target outside of the `ServicePerimeter`, the request will be blocked.
- # Otherwise the request is allowed. There are two types of Service Perimeter -
- # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
- # Google Cloud project can only belong to a single regular Service Perimeter.
- # Service Perimeter Bridges can contain only Google Cloud projects as members,
- # a single Google Cloud project may belong to multiple Service Perimeter
- # Bridges.
- "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
- # restricted/unrestricted services and access levels that determine perimeter
- # content and boundaries.
- # describe specific Service Perimeter configuration.
- "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
- # restrictions. Must contain a list of services. For example, if
- # `storage.googleapis.com` is specified, access to the storage buckets
- # inside the perimeter must meet the perimeter's access restrictions.
- "A String",
+ # import and export data amongst themselves, but not export outside of the
+ # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
+ # has a target outside of the `ServicePerimeter`, the request will be blocked.
+ # Otherwise the request is allowed. There are two types of Service Perimeter -
+ # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
+ # Google Cloud project can only belong to a single regular Service Perimeter.
+ # Service Perimeter Bridges can contain only Google Cloud projects as members,
+ # a single Google Cloud project may belong to multiple Service Perimeter
+ # Bridges.
+ "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`
+ # component must begin with a letter and only include alphanumeric and '_'.
+ # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
+ "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
+ # behavior.
+ "perimeterType": "A String", # Perimeter type indicator. A single project is
+ # allowed to be a member of single regular perimeter, but multiple service
+ # perimeter bridges. A project cannot be a included in a perimeter bridge
+ # without being included in regular perimeter. For perimeter bridges,
+ # restricted/unrestricted service lists as well as access lists must be
+ # empty.
+ "title": "A String", # Human readable title. Must be unique within the Policy.
+ "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
+ # restricted/unrestricted services and access levels that determine perimeter
+ # content and boundaries.
+ # describe specific Service Perimeter configuration.
+ "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
+ # Currently only projects are allowed. Format: `projects/{project_number}`
+ "A String",
+ ],
+ "unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter
+ # restrictions. Deprecated. Must be set to a single wildcard "*".
+ #
+ # The wildcard means that unless explicitly specified by
+ # "restricted_services" list, any service is treated as unrestricted.
+ "A String",
+ ],
+ "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
+ # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
+ # must be in the same policy as this `ServicePerimeter`. Referencing a
+ # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
+ # listed, resources within the perimeter can only be accessed via Google
+ # Cloud calls with request origins within the perimeter. Example:
+ # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
+ # For Service Perimeter Bridge, must be empty.
+ "A String",
+ ],
+ "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
+ # restrictions. Must contain a list of services. For example, if
+ # `storage.googleapis.com` is specified, access to the storage buckets
+ # inside the perimeter must meet the perimeter's access restrictions.
+ "A String",
+ ],
+ "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
+ # Perimeter.
+ "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
+ # unless 'enable_restriction' is True.
+ "A String",
],
- "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.
- # Perimeter.
- "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
- # APIs specified in 'allowed_services'.
- "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
- # unless 'enable_restriction' is True.
- "A String",
- ],
- },
- "unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter
- # restrictions. Deprecated. Must be set to a single wildcard "*".
- #
- # The wildcard means that unless explicitly specified by
- # "restricted_services" list, any service is treated as unrestricted.
- "A String",
- ],
- "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
- # Currently only projects are allowed. Format: `projects/{project_number}`
- "A String",
- ],
- "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
- # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
- # must be in the same policy as this `ServicePerimeter`. Referencing a
- # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
- # listed, resources within the perimeter can only be accessed via Google
- # Cloud calls with request origins within the perimeter. Example:
- # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
- # For Service Perimeter Bridge, must be empty.
- "A String",
- ],
+ "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
+ # APIs specified in 'allowed_services'.
},
- "title": "A String", # Human readable title. Must be unique within the Policy.
- "perimeterType": "A String", # Perimeter type indicator. A single project is
- # allowed to be a member of single regular perimeter, but multiple service
- # perimeter bridges. A project cannot be a included in a perimeter bridge
- # without being included in regular perimeter. For perimeter bridges,
- # restricted/unrestricted service lists as well as access lists must be
- # empty.
- "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`
- # component must begin with a letter and only include alphanumeric and '_'.
- # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
- "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
- # behavior.
- }
+ },
+}
updateMask: string, Required. Mask to control which fields get updated. Must be non-empty.
x__xgafv: string, V1 error format.
@@ -575,34 +575,7 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "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.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
@@ -610,11 +583,38 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
}</pre>
</div>