2024-10-30
▼ ▲ osconfig.projects.locations.global.policyOrchestrators.create
Path : v2beta/{+parent}/policyOrchestrators
Flat Path : v2beta/projects/{projectsId}/locations/global/policyOrchestrators
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource name in the form of: `organizations/{organization_id}/locations/global` `folders/{folder_id}/locations/global` 'projects/{project_id_or_number}/locations/global'
Pattern : ^projects/[^/]+/locations/global$
Location : path
Required : Yes
Type : string
policyOrchestratorId
Description : Required. The logical identifier of the policy orchestrator, with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the parent.
Location : query
Type : string
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).
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new policy orchestrator under the given project resource. `name` field of the given orchestrator are ignored and instead replaced by a product of `parent` and `policy_orchestrator_id`. Orchestrator state field might be only set to `ACTIVE`, `STOPPED` or omitted (in which case, the created resource will be in `ACTIVE` state anyway).
▼ ▲ osconfig.projects.locations.global.policyOrchestrators.list
Path : v2beta/{+parent}/policyOrchestrators
Flat Path : v2beta/projects/{projectsId}/locations/global/policyOrchestrators
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource name.
Pattern : ^projects/[^/]+/locations/global$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A token identifying a page of results the server should return.
Location : query
Type : string
filter
Description : Optional. Filtering results
Location : query
Type : string
orderBy
Description : Optional. Hint for how to order the results
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the policy orchestrators under the given parent project resource.
▼ ▲ osconfig.projects.locations.global.policyOrchestrators.get
Path : v2beta/{+name}
Flat Path : v2beta/projects/{projectsId}/locations/global/policyOrchestrators/{policyOrchestratorsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name.
Pattern : ^projects/[^/]+/locations/global/policyOrchestrators/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieves an existing policy orchestrator, parented by a project.
▼ ▲ osconfig.projects.locations.global.policyOrchestrators.patch
Path : v2beta/{+name}
Flat Path : v2beta/projects/{projectsId}/locations/global/policyOrchestrators/{policyOrchestratorsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. Identifier. In form of * `organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id}` * `folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id}` * `projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}`
Pattern : ^projects/[^/]+/locations/global/policyOrchestrators/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an existing policy orchestrator, parented by a project.
▼ ▲ osconfig.projects.locations.global.policyOrchestrators.delete
Path : v2beta/{+name}
Flat Path : v2beta/projects/{projectsId}/locations/global/policyOrchestrators/{policyOrchestratorsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Name of the resource to be deleted.
Pattern : ^projects/[^/]+/locations/global/policyOrchestrators/[^/]+$
Location : path
Required : Yes
Type : string
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 after 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
Type : string
etag
Description : Optional. The current etag of the policy orchestrator. If an etag is provided and does not match the current etag of the policy orchestrator, deletion will be blocked and an ABORTED error will be returned.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an existing policy orchestrator resource, parented by a project.
▼ ▲ osconfig.folders.locations.global.policyOrchestrators.create
Path : v2beta/{+parent}/policyOrchestrators
Flat Path : v2beta/folders/{foldersId}/locations/global/policyOrchestrators
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource name in the form of: `organizations/{organization_id}/locations/global` `folders/{folder_id}/locations/global` 'projects/{project_id_or_number}/locations/global'
Pattern : ^folders/[^/]+/locations/global$
Location : path
Required : Yes
Type : string
policyOrchestratorId
Description : Required. The logical identifier of the policy orchestrator, with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the parent.
Location : query
Type : string
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).
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new policy orchestrator under the given folder resource. `name` field of the given orchestrator are ignored and instead replaced by a product of `parent` and `policy_orchestrator_id`. Orchestrator state field might be only set to `ACTIVE`, `STOPPED` or omitted (in which case, the created resource will be in `ACTIVE` state anyway).
▼ ▲ osconfig.folders.locations.global.policyOrchestrators.list
Path : v2beta/{+parent}/policyOrchestrators
Flat Path : v2beta/folders/{foldersId}/locations/global/policyOrchestrators
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource name.
Pattern : ^folders/[^/]+/locations/global$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A token identifying a page of results the server should return.
Location : query
Type : string
filter
Description : Optional. Filtering results
Location : query
Type : string
orderBy
Description : Optional. Hint for how to order the results
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the policy orchestrators under the given parent folder resource.
▼ ▲ osconfig.folders.locations.global.policyOrchestrators.get
Path : v2beta/{+name}
Flat Path : v2beta/folders/{foldersId}/locations/global/policyOrchestrators/{policyOrchestratorsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name.
Pattern : ^folders/[^/]+/locations/global/policyOrchestrators/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieves an existing policy orchestrator, parented by a folder.
▼ ▲ osconfig.folders.locations.global.policyOrchestrators.patch
Path : v2beta/{+name}
Flat Path : v2beta/folders/{foldersId}/locations/global/policyOrchestrators/{policyOrchestratorsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. Identifier. In form of * `organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id}` * `folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id}` * `projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}`
Pattern : ^folders/[^/]+/locations/global/policyOrchestrators/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an existing policy orchestrator, parented by a folder.
▼ ▲ osconfig.folders.locations.global.policyOrchestrators.delete
Path : v2beta/{+name}
Flat Path : v2beta/folders/{foldersId}/locations/global/policyOrchestrators/{policyOrchestratorsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Name of the resource to be deleted.
Pattern : ^folders/[^/]+/locations/global/policyOrchestrators/[^/]+$
Location : path
Required : Yes
Type : string
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 after 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
Type : string
etag
Description : Optional. The current etag of the policy orchestrator. If an etag is provided and does not match the current etag of the policy orchestrator, deletion will be blocked and an ABORTED error will be returned.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an existing policy orchestrator resource, parented by a folder.
▼ ▲ osconfig.organizations.locations.global.policyOrchestrators.create
Path : v2beta/{+parent}/policyOrchestrators
Flat Path : v2beta/organizations/{organizationsId}/locations/global/policyOrchestrators
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource name in the form of: `organizations/{organization_id}/locations/global` `folders/{folder_id}/locations/global` 'projects/{project_id_or_number}/locations/global'
Pattern : ^organizations/[^/]+/locations/global$
Location : path
Required : Yes
Type : string
policyOrchestratorId
Description : Required. The logical identifier of the policy orchestrator, with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the parent.
Location : query
Type : string
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).
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new policy orchestrator under the given organizations resource. `name` field of the given orchestrator are ignored and instead replaced by a product of `parent` and `policy_orchestrator_id`. Orchestrator state field might be only set to `ACTIVE`, `STOPPED` or omitted (in which case, the created resource will be in `ACTIVE` state anyway).
▼ ▲ osconfig.organizations.locations.global.policyOrchestrators.list
Path : v2beta/{+parent}/policyOrchestrators
Flat Path : v2beta/organizations/{organizationsId}/locations/global/policyOrchestrators
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource name.
Pattern : ^organizations/[^/]+/locations/global$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A token identifying a page of results the server should return.
Location : query
Type : string
filter
Description : Optional. Filtering results
Location : query
Type : string
orderBy
Description : Optional. Hint for how to order the results
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the policy orchestrators under the given parent organization resource.
▼ ▲ osconfig.organizations.locations.global.policyOrchestrators.get
Path : v2beta/{+name}
Flat Path : v2beta/organizations/{organizationsId}/locations/global/policyOrchestrators/{policyOrchestratorsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name.
Pattern : ^organizations/[^/]+/locations/global/policyOrchestrators/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieves an existing policy orchestrator, parented by an organization.
▼ ▲ osconfig.organizations.locations.global.policyOrchestrators.patch
Path : v2beta/{+name}
Flat Path : v2beta/organizations/{organizationsId}/locations/global/policyOrchestrators/{policyOrchestratorsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. Identifier. In form of * `organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id}` * `folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id}` * `projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}`
Pattern : ^organizations/[^/]+/locations/global/policyOrchestrators/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an existing policy orchestrator, parented by an organization.
▼ ▲ osconfig.organizations.locations.global.policyOrchestrators.delete
Path : v2beta/{+name}
Flat Path : v2beta/organizations/{organizationsId}/locations/global/policyOrchestrators/{policyOrchestratorsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Name of the resource to be deleted.
Pattern : ^organizations/[^/]+/locations/global/policyOrchestrators/[^/]+$
Location : path
Required : Yes
Type : string
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 after 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
Type : string
etag
Description : Optional. The current etag of the policy orchestrator. If an etag is provided and does not match the current etag of the policy orchestrator, deletion will be blocked and an ABORTED error will be returned.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an existing policy orchestrator resource, parented by an organization.