Class: Google::Apis::AssuredworkloadsV1::AssuredworkloadsService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/assuredworkloads_v1/service.rb

Overview

Assured Workloads API

Examples:

require 'google/apis/assuredworkloads_v1'

Assuredworkloads = Google::Apis::AssuredworkloadsV1 # Alias the module
service = Assuredworkloads::AssuredworkloadsService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://assuredworkloads.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AssuredworkloadsService

Returns a new instance of AssuredworkloadsService.



47
48
49
50
51
52
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-assuredworkloads_v1',
        client_version: Google::Apis::AssuredworkloadsV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



40
41
42
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



45
46
47
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#acknowledge_organization_location_workload_violation(name, google_cloud_assuredworkloads_v1_acknowledge_violation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse

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:

  • name (String) —

    Required. The resource name of the Violation to acknowledge. Format: organizations/organization/locations/location/workloads/workload/ violations/violation

  • google_cloud_assuredworkloads_v1_acknowledge_violation_request_object (Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 1119

def acknowledge_organization_location_workload_violation(name, google_cloud_assuredworkloads_v1_acknowledge_violation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:acknowledge', options)
  command.request_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest::Representation
  command.request_object = google_cloud_assuredworkloads_v1_acknowledge_violation_request_object
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#aggregate_folder_location_db_framework_compliance_report(name, filter: nil, interval_end_time: nil, interval_start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse

Gets the aggregated compliance report over time for a given scope.

Parameters:

  • name (String) —

    Required. The name of the aggregated compliance report over time to retrieve. Format: organizations/organization_id/locations/location/ dbFrameworkComplianceReports/db_framework_compliance_report``

  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • interval_end_time (String) (defaults to: nil) —

    Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

  • interval_start_time (String) (defaults to: nil) —

    Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 189

def aggregate_folder_location_db_framework_compliance_report(name, filter: nil, interval_end_time: nil, interval_start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:aggregate', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['interval.endTime'] = interval_end_time unless interval_end_time.nil?
  command.query['interval.startTime'] = interval_start_time unless interval_start_time.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#aggregate_organization_location_db_framework_compliance_report(name, filter: nil, interval_end_time: nil, interval_start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse

Gets the aggregated compliance report over time for a given scope.

Parameters:

  • name (String) —

    Required. The name of the aggregated compliance report over time to retrieve. Format: organizations/organization_id/locations/location/ dbFrameworkComplianceReports/db_framework_compliance_report``

  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • interval_end_time (String) (defaults to: nil) —

    Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

  • interval_start_time (String) (defaults to: nil) —

    Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 405

def aggregate_organization_location_db_framework_compliance_report(name, filter: nil, interval_end_time: nil, interval_start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:aggregate', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['interval.endTime'] = interval_end_time unless interval_end_time.nil?
  command.query['interval.startTime'] = interval_start_time unless interval_start_time.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#aggregate_project_location_db_framework_compliance_report(name, filter: nil, interval_end_time: nil, interval_start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse

Gets the aggregated compliance report over time for a given scope.

Parameters:

  • name (String) —

    Required. The name of the aggregated compliance report over time to retrieve. Format: organizations/organization_id/locations/location/ dbFrameworkComplianceReports/db_framework_compliance_report``

  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • interval_end_time (String) (defaults to: nil) —

    Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

  • interval_start_time (String) (defaults to: nil) —

    Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 1327

def aggregate_project_location_db_framework_compliance_report(name, filter: nil, interval_end_time: nil, interval_start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:aggregate', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['interval.endTime'] = interval_end_time unless interval_end_time.nil?
  command.query['interval.startTime'] = interval_start_time unless interval_start_time.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#analyze_organization_location_workload_workload_move(target, asset_types: nil, page_size: nil, page_token: nil, project: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse

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:

  • target (String) —

    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"

  • asset_types (Array<String>, String) (defaults to: nil) —

    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.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50.

  • page_token (String) (defaults to: nil) —

    Optional. The page token from the previous response. It needs to be passed in the second and following requests.

  • project (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 671

def analyze_organization_location_workload_workload_move(target, asset_types: nil, page_size: nil, page_token: nil, project: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+target}:analyzeWorkloadMove', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse
  command.params['target'] = target unless target.nil?
  command.query['assetTypes'] = asset_types unless asset_types.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['project'] = project unless project.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#apply_organization_location_workload_update(name, google_cloud_assuredworkloads_v1_apply_workload_update_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleLongrunningOperation

This endpoint creates a new operation to apply the given update.

Parameters:

  • name (String) —

    Required. The resource name of the update. Format: organizations/org_id/ locations/location_id/workloads/workload_id/updates/update_id

  • google_cloud_assuredworkloads_v1_apply_workload_update_request_object (Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 1044

def apply_organization_location_workload_update(name, google_cloud_assuredworkloads_v1_apply_workload_update_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:apply', options)
  command.request_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest::Representation
  command.request_object = google_cloud_assuredworkloads_v1_apply_workload_update_request_object
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#archive_assuredworkload_resource_events(google_cloud_assuredworkloads_v1_archive_resource_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ArchiveResourceEventsResponse

Finds orphan ResourceEvents matching the criteria and moves them to the ArchivedResourceEvents table.

Parameters:

  • google_cloud_assuredworkloads_v1_archive_resource_events_request_object (Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ArchiveResourceEventsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



74
75
76
77
78
79
80
81
82
83
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 74

def archive_assuredworkload_resource_events(google_cloud_assuredworkloads_v1_archive_resource_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/assuredworkloads:archiveResourceEvents', options)
  command.request_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ArchiveResourceEventsRequest::Representation
  command.request_object = google_cloud_assuredworkloads_v1_archive_resource_events_request_object
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ArchiveResourceEventsResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ArchiveResourceEventsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_organization_location_workload_violation_acknowledge_violations(parent, google_cloud_assuredworkloads_v1_batch_acknowledge_violations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1BatchAcknowledgeViolationsResponse

Acknowledges multiple existing violations. By acknowledging violations, users acknowledge the existence of compliance violations in their workload and decide to ignore them due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted. This is a batch version of AcknowledgeViolation.

Parameters:

  • parent (String) —

    Optional. The parent resource shared by all violations being acknowledged. Format: organizations/organization/locations/location/workloads/workload

  • google_cloud_assuredworkloads_v1_batch_acknowledge_violations_request_object (Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1BatchAcknowledgeViolationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 1157

def batch_organization_location_workload_violation_acknowledge_violations(parent, google_cloud_assuredworkloads_v1_batch_acknowledge_violations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/violations:batchAcknowledgeViolations', options)
  command.request_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1BatchAcknowledgeViolationsRequest::Representation
  command.request_object = google_cloud_assuredworkloads_v1_batch_acknowledge_violations_request_object
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1BatchAcknowledgeViolationsResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1BatchAcknowledgeViolationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_location_workload(parent, google_cloud_assuredworkloads_v1_workload_object = nil, external_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleLongrunningOperation

Creates Assured Workload.

Parameters:

  • parent (String) —

    Required. The resource name of the new Workload's parent. Must be of the form organizations/org_id/locations/location_id``.

  • google_cloud_assuredworkloads_v1_workload_object (Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Workload) (defaults to: nil)
  • external_id (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



712
713
714
715
716
717
718
719
720
721
722
723
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 712

def create_organization_location_workload(parent, google_cloud_assuredworkloads_v1_workload_object = nil, external_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/workloads', options)
  command.request_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Workload::Representation
  command.request_object = google_cloud_assuredworkloads_v1_workload_object
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['externalId'] = external_id unless external_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_location_workload(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleProtobufEmpty

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:

  • name (String) —

    Required. The name field is used to identify the workload. Format: organizations/org_id/locations/location_id/workloads/workload_id

  • etag (String) (defaults to: nil) —

    Optional. The etag of the workload. If this is provided, it must match the server's etag.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



753
754
755
756
757
758
759
760
761
762
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 753

def delete_organization_location_workload(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enable_organization_location_workload_compliance_updates(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse

This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have resourcemanager. folders.getIamPolicy and resourcemanager.folders.setIamPolicy permissions on the assured workload folder.

Parameters:

  • name (String) —

    Required. The name field is used to identify the workload. Format: organizations/org_id/locations/location_id/workloads/workload_id

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



790
791
792
793
794
795
796
797
798
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 790

def enable_organization_location_workload_compliance_updates(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}:enableComplianceUpdates', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enable_organization_location_workload_resource_monitoring(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse

Enable resource violation monitoring for a workload.

Parameters:

  • name (String) —

    Required. The name field is used to identify the workload. Format: organizations/org_id/locations/location_id/workloads/workload_id

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



821
822
823
824
825
826
827
828
829
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 821

def enable_organization_location_workload_resource_monitoring(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:enableResourceMonitoring', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_folder_location_db_framework_compliance_report(name, end_time: nil, filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse

Fetches the framework compliance report for a given scope.

Parameters:

  • name (String) —

    Required. The name of the framework compliance report to retrieve.

  • end_time (String) (defaults to: nil) —

    Optional. The end time of the report.

  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 226

def fetch_folder_location_db_framework_compliance_report(name, end_time: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:fetch', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse
  command.params['name'] = name unless name.nil?
  command.query['endTime'] = end_time unless end_time.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_organization_location_db_framework_compliance_report(name, end_time: nil, filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse

Fetches the framework compliance report for a given scope.

Parameters:

  • name (String) —

    Required. The name of the framework compliance report to retrieve.

  • end_time (String) (defaults to: nil) —

    Optional. The end time of the report.

  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 442

def fetch_organization_location_db_framework_compliance_report(name, end_time: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:fetch', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse
  command.params['name'] = name unless name.nil?
  command.query['endTime'] = end_time unless end_time.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_project_location_db_framework_compliance_report(name, end_time: nil, filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse

Fetches the framework compliance report for a given scope.

Parameters:

  • name (String) —

    Required. The name of the framework compliance report to retrieve.

  • end_time (String) (defaults to: nil) —

    Optional. The end time of the report.

  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 1364

def fetch_project_location_db_framework_compliance_report(name, end_time: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:fetch', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse
  command.params['name'] = name unless name.nil?
  command.query['endTime'] = end_time unless end_time.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleLongrunningOperation

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:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



569
570
571
572
573
574
575
576
577
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 569

def get_organization_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_location_workload(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Workload

Gets Assured Workload associated with a CRM Node

Parameters:

  • name (String) —

    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".

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



854
855
856
857
858
859
860
861
862
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 854

def get_organization_location_workload(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Workload::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Workload
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_location_workload_violation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Violation

Retrieves Assured Workload Violation based on ID.

Parameters:

  • name (String) —

    Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/organization/locations/location/workloads/workload/ violations/violation

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 1191

def get_organization_location_workload_violation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Violation::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Violation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_folder_location_db_finding_summaries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse

Lists the finding summary by category for a given scope.

Parameters:

  • parent (String) —

    Required. The parent scope for the framework overview page. Formats: - projects/project/locations/location - folders/folder/locations/location

    • organizations/organization/locations/location
  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.

  • page_token (String) (defaults to: nil) —

    Optional. A token that identifies the page of results that the server should return.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 146

def list_folder_location_db_finding_summaries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dbFindingSummaries', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_folder_location_db_framework_compliance_report_db_control_compliance_summaries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse

Lists the control compliance summary for a given scope.

Parameters:

  • parent (String) —

    Required. The parent scope for the framework overview page. Format: organizations/organization/locations/location/dbFrameworkComplianceReports/ db_framework_compliance_report folders/folder/locations/location/ dbFrameworkComplianceReports/db_framework_compliance_report projects/ project/locations/location/dbFrameworkComplianceReports/ db_framework_compliance_report

  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.

  • page_token (String) (defaults to: nil) —

    Optional. A token that identifies the page of results that the server should return.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 272

def list_folder_location_db_framework_compliance_report_db_control_compliance_summaries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dbControlComplianceSummaries', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_folder_location_db_framework_compliance_summaries(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse

Lists the framework compliance summary for a given scope.

Parameters:

  • parent (String) —

    Required. The parent scope for the framework compliance summary. Format: organizations/organization/locations/location folders/folder/locations/ location projects/project/locations/location

  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.

  • page_token (String) (defaults to: nil) —

    Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.

  • view (String) (defaults to: nil) —

    Optional. Specifies the level of detail to return in the response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 318

def list_folder_location_db_framework_compliance_summaries(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dbFrameworkComplianceSummaries', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_location_db_finding_summaries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse

Lists the finding summary by category for a given scope.

Parameters:

  • parent (String) —

    Required. The parent scope for the framework overview page. Formats: - projects/project/locations/location - folders/folder/locations/location

    • organizations/organization/locations/location
  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.

  • page_token (String) (defaults to: nil) —

    Optional. A token that identifies the page of results that the server should return.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 362

def list_organization_location_db_finding_summaries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dbFindingSummaries', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_location_db_framework_compliance_report_db_control_compliance_summaries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse

Lists the control compliance summary for a given scope.

Parameters:

  • parent (String) —

    Required. The parent scope for the framework overview page. Format: organizations/organization/locations/location/dbFrameworkComplianceReports/ db_framework_compliance_report folders/folder/locations/location/ dbFrameworkComplianceReports/db_framework_compliance_report projects/ project/locations/location/dbFrameworkComplianceReports/ db_framework_compliance_report

  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.

  • page_token (String) (defaults to: nil) —

    Optional. A token that identifies the page of results that the server should return.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 488

def list_organization_location_db_framework_compliance_report_db_control_compliance_summaries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dbControlComplianceSummaries', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_location_db_framework_compliance_summaries(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse

Lists the framework compliance summary for a given scope.

Parameters:

  • parent (String) —

    Required. The parent scope for the framework compliance summary. Format: organizations/organization/locations/location folders/folder/locations/ location projects/project/locations/location

  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.

  • page_token (String) (defaults to: nil) —

    Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.

  • view (String) (defaults to: nil) —

    Optional. Specifies the level of detail to return in the response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 534

def list_organization_location_db_framework_compliance_summaries(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dbFrameworkComplianceSummaries', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • return_partial_success (Boolean) (defaults to: nil) —

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 614

def list_organization_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_location_workload_updates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse

This endpoint lists all updates for the given workload.

Parameters:

  • parent (String) —

    Required. organizations/org_id/locations/location_id/workloads/ workload_id

  • page_size (Fixnum) (defaults to: nil) —

    Page size. The default value is 20 and the max allowed value is 100.

  • page_token (String) (defaults to: nil) —

    Page token returned from previous request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 1081

def list_organization_location_workload_updates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/updates', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_location_workload_violations(parent, filter: nil, interval_end_time: nil, interval_start_time: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListViolationsResponse

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:

  • parent (String) —

    Required. The Workload name. Format organizations/org_id/locations/ location/workloads/workload``.

  • filter (String) (defaults to: nil) —

    Optional. A custom filter for filtering by the Violations properties.

  • interval_end_time (String) (defaults to: nil) —

    The end of the time window.

  • interval_start_time (String) (defaults to: nil) —

    The start of the time window.

  • order_by (String) (defaults to: nil) —

    Optional. Actionable sorting delegation.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Page size.

  • page_token (String) (defaults to: nil) —

    Optional. Page token returned from previous request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 1238

def list_organization_location_workload_violations(parent, filter: nil, interval_end_time: nil, interval_start_time: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/violations', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListViolationsResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListViolationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['interval.endTime'] = interval_end_time unless interval_end_time.nil?
  command.query['interval.startTime'] = interval_start_time unless interval_start_time.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_location_workloads(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListWorkloadsResponse

Lists Assured Workloads under a CRM Node.

Parameters:

  • parent (String) —

    Required. Parent Resource to list workloads from. Must be of the form organizations/org_id/locations/location``.

  • filter (String) (defaults to: nil) —

    A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.

  • page_size (Fixnum) (defaults to: nil) —

    Page size.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



894
895
896
897
898
899
900
901
902
903
904
905
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 894

def list_organization_location_workloads(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/workloads', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListWorkloadsResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListWorkloadsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_db_finding_summaries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse

Lists the finding summary by category for a given scope.

Parameters:

  • parent (String) —

    Required. The parent scope for the framework overview page. Formats: - projects/project/locations/location - folders/folder/locations/location

    • organizations/organization/locations/location
  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.

  • page_token (String) (defaults to: nil) —

    Optional. A token that identifies the page of results that the server should return.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 1284

def list_project_location_db_finding_summaries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dbFindingSummaries', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_db_framework_compliance_report_db_control_compliance_summaries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse

Lists the control compliance summary for a given scope.

Parameters:

  • parent (String) —

    Required. The parent scope for the framework overview page. Format: organizations/organization/locations/location/dbFrameworkComplianceReports/ db_framework_compliance_report folders/folder/locations/location/ dbFrameworkComplianceReports/db_framework_compliance_report projects/ project/locations/location/dbFrameworkComplianceReports/ db_framework_compliance_report

  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.

  • page_token (String) (defaults to: nil) —

    Optional. A token that identifies the page of results that the server should return.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 1410

def list_project_location_db_framework_compliance_report_db_control_compliance_summaries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dbControlComplianceSummaries', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_db_framework_compliance_summaries(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse

Lists the framework compliance summary for a given scope.

Parameters:

  • parent (String) —

    Required. The parent scope for the framework compliance summary. Format: organizations/organization/locations/location folders/folder/locations/ location projects/project/locations/location

  • filter (String) (defaults to: nil) —

    Optional. The filtering results.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.

  • page_token (String) (defaults to: nil) —

    Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.

  • view (String) (defaults to: nil) —

    Optional. Specifies the level of detail to return in the response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 1456

def list_project_location_db_framework_compliance_summaries(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dbFrameworkComplianceSummaries', options)
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#mutate_organization_location_workload_partner_permissions(name, google_cloud_assuredworkloads_v1_mutate_partner_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Workload

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:

  • name (String) —

    Required. The name field is used to identify the workload. Format: organizations/org_id/locations/location_id/workloads/workload_id

  • google_cloud_assuredworkloads_v1_mutate_partner_permissions_request_object (Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



931
932
933
934
935
936
937
938
939
940
941
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 931

def mutate_organization_location_workload_partner_permissions(name, google_cloud_assuredworkloads_v1_mutate_partner_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}:mutatePartnerPermissions', options)
  command.request_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest::Representation
  command.request_object = google_cloud_assuredworkloads_v1_mutate_partner_permissions_request_object
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Workload::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Workload
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_organization_location_workload(name, google_cloud_assuredworkloads_v1_workload_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Workload

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:

  • name (String) —

    Optional. The resource name of the workload. Format: organizations/ organization/locations/location/workloads/workload Read-only.

  • google_cloud_assuredworkloads_v1_workload_object (Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Workload) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The list of fields to be updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



969
970
971
972
973
974
975
976
977
978
979
980
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 969

def patch_organization_location_workload(name, google_cloud_assuredworkloads_v1_workload_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Workload::Representation
  command.request_object = google_cloud_assuredworkloads_v1_workload_object
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Workload::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Workload
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#restrict_organization_location_workload_allowed_resources(name, google_cloud_assuredworkloads_v1_restrict_allowed_resources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse

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:

  • name (String) —

    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".

  • google_cloud_assuredworkloads_v1_restrict_allowed_resources_request_object (Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 1010

def restrict_organization_location_workload_allowed_resources(name, google_cloud_assuredworkloads_v1_restrict_allowed_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:restrictAllowedResources', options)
  command.request_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest::Representation
  command.request_object = google_cloud_assuredworkloads_v1_restrict_allowed_resources_request_object
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#revert_assuredworkload_archived_resource_events(google_cloud_assuredworkloads_v1_revert_archived_resource_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1RevertArchivedResourceEventsResponse

Finds matching ArchivedResourceEvents and moves them back to the ResourceEvents table.

Parameters:

  • google_cloud_assuredworkloads_v1_revert_archived_resource_events_request_object (Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1RevertArchivedResourceEventsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/google/apis/assuredworkloads_v1/service.rb', line 105

def revert_assuredworkload_archived_resource_events(google_cloud_assuredworkloads_v1_revert_archived_resource_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/assuredworkloads:revertArchivedResourceEvents', options)
  command.request_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1RevertArchivedResourceEventsRequest::Representation
  command.request_object = google_cloud_assuredworkloads_v1_revert_archived_resource_events_request_object
  command.response_representation = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1RevertArchivedResourceEventsResponse::Representation
  command.response_class = Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1RevertArchivedResourceEventsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end