2023-05-20
▼ ▲ networksecurity.projects.locations.addressGroups.addItems
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Adds items to an address group.
Path: v1/{+addressGroup}:addItems
Parameter Order: addressGroup
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:addItems
Parameters:
addressGroup
Type: string
Description: Required. A name of the AddressGroup to add items to. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
▼ ▲ networksecurity.projects.locations.addressGroups.testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
HTTP Method: POST
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Type: string
Required: Yes
Path: v1/{+resource}:testIamPermissions
Parameter Order: resource
▼ ▲ networksecurity.projects.locations.addressGroups.cloneItems
Parameters:
addressGroup
Type: string
Description: Required. A name of the AddressGroup to clone items to. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:cloneItems
HTTP Method: POST
Parameter Order: addressGroup
Description: Clones items from one address group to another.
Path: v1/{+addressGroup}:cloneItems
▼ ▲ networksecurity.projects.locations.addressGroups.patch
Description: Updates the parameters of a single address group.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Parameters:
name
Required: Yes
Description: Required. Name of the AddressGroup resource. It matches pattern `projects/*/locations/{location}/addressGroups/`.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Type: string
updateMask
Type: string
Format: google-fieldmask
Location: query
Description: Optional. Field mask is used to specify the fields to be overwritten in the AddressGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
requestId
Type: string
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}
Parameter Order: name
Path: v1/{+name}
▼ ▲ networksecurity.projects.locations.addressGroups.setIamPolicy
HTTP Method: POST
Parameter Order: resource
Path: v1/{+resource}:setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:setIamPolicy
▼ ▲ networksecurity.projects.locations.addressGroups.listReferences
Parameter Order: addressGroup
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:listReferences
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+addressGroup}:listReferences
Parameters:
pageSize
Location: query
Format: int32
Description: The maximum number of references to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more AddressGroupUsers left to be queried.
Type: integer
pageToken
Location: query
Type: string
Description: The next_page_token value returned from a previous List request, if any.
addressGroup
Type: string
Description: Required. A name of the AddressGroup to clone items to. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Required: Yes
Location: path
HTTP Method: GET
Description: Lists references of an address group.
▼ ▲ networksecurity.projects.locations.addressGroups.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/addressGroups
Description: Lists address groups in a given project and location.
Path: v1/{+parent}/addressGroups
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
Parameters:
parent
Description: Required. The project and location from which the AddressGroups should be listed, specified in the format `projects/*/locations/{location}`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Type: string
pageToken
Description: The value returned by the last `ListAddressGroupsResponse` Indicates that this is a continuation of a prior `ListAddressGroups` call, and that the system should return the next page of data.
Location: query
Type: string
pageSize
Format: int32
Description: Maximum number of AddressGroups to return per call.
Type: integer
Location: query
▼ ▲ networksecurity.projects.locations.addressGroups.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/addressGroups
Parameters:
requestId
Location: query
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: Required. The parent resource of the AddressGroup. Must be in the format `projects/*/locations/{location}`.
Type: string
addressGroupId
Description: Required. Short name of the AddressGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".
Location: query
Type: string
Description: Creates a new address group in a given project and location.
HTTP Method: POST
Parameter Order: parent
Path: v1/{+parent}/addressGroups
▼ ▲ networksecurity.projects.locations.addressGroups.get
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Location: path
Description: Required. A name of the AddressGroup to get. Must be in the format `projects/*/locations/{location}/addressGroups/*`.
Required: Yes
Parameter Order: name
Path: v1/{+name}
Description: Gets details of a single address group.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}
▼ ▲ networksecurity.projects.locations.addressGroups.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameters:
requestId
Type: string
Location: query
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
name
Required: Yes
Description: Required. A name of the AddressGroup to delete. Must be in the format `projects/*/locations/{location}/addressGroups/*`.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Location: path
HTTP Method: DELETE
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}
Description: Deletes a single address group.
▼ ▲ networksecurity.projects.locations.addressGroups.getIamPolicy
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:getIamPolicy
HTTP Method: GET
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Type: string
Required: Yes
options.requestedPolicyVersion
Location: query
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Format: int32
Type: integer
▼ ▲ networksecurity.projects.locations.addressGroups.removeItems
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:removeItems
Path: v1/{+addressGroup}:removeItems
HTTP Method: POST
Description: Removes items from an address group.
Parameters:
addressGroup
Location: path
Type: string
Description: Required. A name of the AddressGroup to remove items from. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Parameter Order: addressGroup
▼ ▲ networksecurity.organizations.locations.operations.get
Parameter Order: name
Parameters:
name
Required: Yes
Location: path
Type: string
Description: The name of the operation resource.
Pattern: ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
HTTP Method: GET
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ networksecurity.organizations.locations.operations.list
Parameters:
name
Description: The name of the operation's parent resource.
Type: string
Required: Yes
Pattern: ^organizations/[^/]+/locations/[^/]+$
Location: path
pageSize
Type: integer
Description: The standard list page size.
Location: query
Format: int32
pageToken
Location: query
Type: string
Description: The standard list page token.
filter
Location: query
Type: string
Description: The standard list filter.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}/operations
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/operations
▼ ▲ networksecurity.organizations.locations.operations.delete
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameters:
name
Pattern: ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
Type: string
Location: path
Description: The name of the operation resource to be deleted.
Path: v1/{+name}
HTTP Method: DELETE
Parameter Order: name
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ networksecurity.organizations.locations.operations.cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
name
Pattern: ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
Required: Yes
Location: path
Description: The name of the operation resource to be cancelled.
Parameter Order: name
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Path: v1/{+name}:cancel
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel
▼ ▲ networksecurity.organizations.locations.addressGroups.listReferences
Parameters:
addressGroup
Type: string
Pattern: ^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Required: Yes
Description: Required. A name of the AddressGroup to clone items to. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Location: path
pageSize
Type: integer
Format: int32
Description: The maximum number of references to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more AddressGroupUsers left to be queried.
Location: query
pageToken
Location: query
Description: The next_page_token value returned from a previous List request, if any.
Type: string
Description: Lists references of an address group.
Parameter Order: addressGroup
HTTP Method: GET
Path: v1/{+addressGroup}:listReferences
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:listReferences
▼ ▲ networksecurity.organizations.locations.addressGroups.cloneItems
Path: v1/{+addressGroup}:cloneItems
Parameters:
addressGroup
Description: Required. A name of the AddressGroup to clone items to. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Pattern: ^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Location: path
Type: string
Required: Yes
HTTP Method: POST
Description: Clones items from one address group to another.
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:cloneItems
Parameter Order: addressGroup
▼ ▲ networksecurity.organizations.locations.addressGroups.removeItems
Description: Removes items from an address group.
Parameter Order: addressGroup
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:removeItems
HTTP Method: POST
Path: v1/{+addressGroup}:removeItems
Parameters:
addressGroup
Type: string
Pattern: ^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Required: Yes
Location: path
Description: Required. A name of the AddressGroup to remove items from. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
▼ ▲ networksecurity.organizations.locations.addressGroups.get
Path: v1/{+name}
HTTP Method: GET
Parameters:
name
Location: path
Type: string
Required: Yes
Description: Required. A name of the AddressGroup to get. Must be in the format `projects/*/locations/{location}/addressGroups/*`.
Pattern: ^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Description: Gets details of a single address group.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}
▼ ▲ networksecurity.organizations.locations.addressGroups.delete
Path: v1/{+name}
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes an address group.
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}
Parameters:
name
Type: string
Pattern: ^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Description: Required. A name of the AddressGroup to delete. Must be in the format `projects/*/locations/{location}/addressGroups/*`.
Required: Yes
Location: path
requestId
Location: query
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type: string
Parameter Order: name
▼ ▲ networksecurity.organizations.locations.addressGroups.patch
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}
Description: Updates parameters of an address group.
Parameters:
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type: string
Location: query
name
Required: Yes
Pattern: ^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Location: path
Description: Required. Name of the AddressGroup resource. It matches pattern `projects/*/locations/{location}/addressGroups/`.
Type: string
updateMask
Location: query
Description: Optional. Field mask is used to specify the fields to be overwritten in the AddressGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Format: google-fieldmask
Type: string
Parameter Order: name
▼ ▲ networksecurity.organizations.locations.addressGroups.addItems
Parameters:
addressGroup
Type: string
Pattern: ^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$
Location: path
Required: Yes
Description: Required. A name of the AddressGroup to add items to. Must be in the format `projects|organization/*/locations/{location}/addressGroups/*`.
Path: v1/{+addressGroup}:addItems
Description: Adds items to an address group.
HTTP Method: POST
Parameter Order: addressGroup
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:addItems
▼ ▲ networksecurity.organizations.locations.addressGroups.list
Path: v1/{+parent}/addressGroups
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists address groups in a given project and location.
HTTP Method: GET
Parameters:
parent
Pattern: ^organizations/[^/]+/locations/[^/]+$
Description: Required. The project and location from which the AddressGroups should be listed, specified in the format `projects/*/locations/{location}`.
Location: path
Type: string
Required: Yes
pageToken
Type: string
Location: query
Description: The value returned by the last `ListAddressGroupsResponse` Indicates that this is a continuation of a prior `ListAddressGroups` call, and that the system should return the next page of data.
pageSize
Location: query
Format: int32
Type: integer
Description: Maximum number of AddressGroups to return per call.
Parameter Order: parent
▼ ▲ networksecurity.organizations.locations.addressGroups.create
Description: Creates a new address group in a given project and location.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups
Parameters:
requestId
Location: query
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type: string
parent
Description: Required. The parent resource of the AddressGroup. Must be in the format `projects/*/locations/{location}`.
Type: string
Pattern: ^organizations/[^/]+/locations/[^/]+$
Required: Yes
Location: path
addressGroupId
Description: Required. Short name of the AddressGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".
Location: query
Type: string
Parameter Order: parent
Path: v1/{+parent}/addressGroups