View Source GoogleApi.AssuredWorkloads.V1.Api.Organizations (google_api_assured_workloads v0.14.0)
API calls for all endpoints tagged Organizations
.
Summary
Functions
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.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.
Creates Assured Workload.
Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.
Enable resource violation monitoring for a workload.
Gets Assured Workload associated with a CRM Node
Lists Assured Workloads under a CRM Node.
Update the permissions settings for an existing partner workload. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.
Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.
Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.
Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.
Retrieves Assured Workload Violation based on ID.
Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format organizations/{org_id}/locations/{location}/workloads/-
Functions
assuredworkloads_organizations_locations_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec assuredworkloads_organizations_locations_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AssuredWorkloads.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AssuredWorkloads.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AssuredWorkloads.V1.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
assuredworkloads_organizations_locations_operations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec assuredworkloads_organizations_locations_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AssuredWorkloads.V1.Model.GoogleLongrunningListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters
-
connection
(type:GoogleApi.AssuredWorkloads.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AssuredWorkloads.V1.Model.GoogleLongrunningListOperationsResponse{}}
on success -
{:error, info}
on failure
assuredworkloads_organizations_locations_workloads_analyze_workload_move(connection, target, optional_params \\ [], opts \\ [])
View Source@spec assuredworkloads_organizations_locations_workloads_analyze_workload_move( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.
Parameters
-
connection
(type:GoogleApi.AssuredWorkloads.V1.Connection.t
) - Connection to server -
target
(type:String.t
) - Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2" -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:assetTypes
(type:list(String.t)
) - Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available here. -
:pageSize
(type:integer()
) - Optional. Page size. If a value is not specified, the default value of 10 is used. -
:pageToken
(type:String.t
) - Optional. The page token from the previous response. It needs to be passed in the second and following requests. -
:project
(type:String.t
) - The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: "projects/{PROJECT_NUMBER}" or "projects/{PROJECT_ID}" For example: "projects/951040570662" when specifying a project number, or "projects/my-project-123" when specifying a project ID.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse{}}
on success -
{:error, info}
on failure
assuredworkloads_organizations_locations_workloads_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec assuredworkloads_organizations_locations_workloads_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AssuredWorkloads.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates Assured Workload.
Parameters
-
connection
(type:GoogleApi.AssuredWorkloads.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The resource name of the new Workload's parent. Must be of the formorganizations/{org_id}/locations/{location_id}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:externalId
(type:String.t
) - Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value. -
:body
(type:GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1Workload.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AssuredWorkloads.V1.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
assuredworkloads_organizations_locations_workloads_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec assuredworkloads_organizations_locations_workloads_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AssuredWorkloads.V1.Model.GoogleProtobufEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.
Parameters
-
connection
(type:GoogleApi.AssuredWorkloads.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Thename
field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:etag
(type:String.t
) - Optional. The etag of the workload. If this is provided, it must match the server's etag.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AssuredWorkloads.V1.Model.GoogleProtobufEmpty{}}
on success -
{:error, info}
on failure
assuredworkloads_organizations_locations_workloads_enable_resource_monitoring(connection, name, optional_params \\ [], opts \\ [])
View Source@spec assuredworkloads_organizations_locations_workloads_enable_resource_monitoring( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Enable resource violation monitoring for a workload.
Parameters
-
connection
(type:GoogleApi.AssuredWorkloads.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Thename
field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse{}}
on success -
{:error, info}
on failure
assuredworkloads_organizations_locations_workloads_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec assuredworkloads_organizations_locations_workloads_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1Workload.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets Assured Workload associated with a CRM Node
Parameters
-
connection
(type:GoogleApi.AssuredWorkloads.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1". -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1Workload{}}
on success -
{:error, info}
on failure
assuredworkloads_organizations_locations_workloads_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec assuredworkloads_organizations_locations_workloads_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1ListWorkloadsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists Assured Workloads under a CRM Node.
Parameters
-
connection
(type:GoogleApi.AssuredWorkloads.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Parent Resource to list workloads from. Must be of the formorganizations/{org_id}/locations/{location}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported. -
:pageSize
(type:integer()
) - Page size. -
:pageToken
(type:String.t
) - Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1ListWorkloadsResponse{}}
on success -
{:error, info}
on failure
assuredworkloads_organizations_locations_workloads_mutate_partner_permissions(connection, name, optional_params \\ [], opts \\ [])
View Source@spec assuredworkloads_organizations_locations_workloads_mutate_partner_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1Workload.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Update the permissions settings for an existing partner workload. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.
Parameters
-
connection
(type:GoogleApi.AssuredWorkloads.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Thename
field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1Workload{}}
on success -
{:error, info}
on failure
assuredworkloads_organizations_locations_workloads_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec assuredworkloads_organizations_locations_workloads_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1Workload.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.
Parameters
-
connection
(type:GoogleApi.AssuredWorkloads.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The list of fields to be updated. -
:body
(type:GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1Workload.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1Workload{}}
on success -
{:error, info}
on failure
assuredworkloads_organizations_locations_workloads_restrict_allowed_resources(connection, name, optional_params \\ [], opts \\ [])
View Source@spec assuredworkloads_organizations_locations_workloads_restrict_allowed_resources( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.
Parameters
-
connection
(type:GoogleApi.AssuredWorkloads.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1". -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse{}}
on success -
{:error, info}
on failure
assuredworkloads_organizations_locations_workloads_violations_acknowledge(connection, name, optional_params \\ [], opts \\ [])
View Source@spec assuredworkloads_organizations_locations_workloads_violations_acknowledge( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.
Parameters
-
connection
(type:GoogleApi.AssuredWorkloads.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the Violation to acknowledge. Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse{}}
on success -
{:error, info}
on failure
assuredworkloads_organizations_locations_workloads_violations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec assuredworkloads_organizations_locations_workloads_violations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1Violation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves Assured Workload Violation based on ID.
Parameters
-
connection
(type:GoogleApi.AssuredWorkloads.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1Violation{}}
on success -
{:error, info}
on failure
assuredworkloads_organizations_locations_workloads_violations_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec assuredworkloads_organizations_locations_workloads_violations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1ListViolationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format organizations/{org_id}/locations/{location}/workloads/-
Parameters
-
connection
(type:GoogleApi.AssuredWorkloads.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The Workload name. Formatorganizations/{org_id}/locations/{location}/workloads/{workload}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional. A custom filter for filtering by the Violations properties. -
:"interval.endTime"
(type:DateTime.t
) - The end of the time window. -
:"interval.startTime"
(type:DateTime.t
) - The start of the time window. -
:pageSize
(type:integer()
) - Optional. Page size. -
:pageToken
(type:String.t
) - Optional. Page token returned from previous request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AssuredWorkloads.V1.Model.GoogleCloudAssuredworkloadsV1ListViolationsResponse{}}
on success -
{:error, info}
on failure