Google Git
Sign in
flutter/third_party/googleapis.dart.git/refs/heads/master/./generated/googleapis/lib/policysimulator/v1.dart
blob: 78346f907dabec70abc2dba4f817ae099c050ba5 [file] [edit]
// Copyright 2021 Google LLC
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file or at
// https://developers.google.com/open-source/licenses/bsd
// This is a generated file (see the discoveryapis_generator project).
// ignore_for_file: camel_case_types
// ignore_for_file: comment_references
// ignore_for_file: deprecated_member_use_from_same_package
// ignore_for_file: doc_directive_unknown
// ignore_for_file: lines_longer_than_80_chars
// ignore_for_file: non_constant_identifier_names
// ignore_for_file: prefer_interpolation_to_compose_strings
// ignore_for_file: unintended_html_in_doc_comment
// ignore_for_file: unnecessary_brace_in_string_interps
// ignore_for_file: unnecessary_lambdas
// ignore_for_file: unnecessary_string_interpolations
/// Policy Simulator API - v1
///
/// Policy Simulator is a collection of endpoints for creating, running, and
/// viewing a Replay. A `Replay` is a type of simulation that lets you see how
/// your members' access to resources might change if you changed your IAM
/// policy. During a `Replay`, Policy Simulator re-evaluates, or replays, past
/// access attempts under both the current policy and your proposed policy, and
/// compares those results to determine how your members' access might change
/// under the proposed policy.
///
/// For more information, see
/// <https://cloud.google.com/iam/docs/simulating-access>
///
/// Create an instance of [PolicySimulatorApi] to access these resources:
///
/// - [FoldersResource]
/// - [FoldersLocationsResource]
/// - [FoldersLocationsAccessPolicySimulationsResource]
/// - [FoldersLocationsAccessPolicySimulationsOperationsResource]
/// - [FoldersLocationsOrgPolicyViolationsPreviewsResource]
/// - [FoldersLocationsOrgPolicyViolationsPreviewsOperationsResource]
/// - [FoldersLocationsReplaysResource]
/// - [FoldersLocationsReplaysOperationsResource]
/// - [FoldersLocationsReplaysResultsResource]
/// - [OperationsResource]
/// - [OrganizationsResource]
/// - [OrganizationsLocationsResource]
/// - [OrganizationsLocationsAccessPolicySimulationsResource]
/// - [OrganizationsLocationsAccessPolicySimulationsOperationsResource]
/// - [OrganizationsLocationsOrgPolicyViolationsPreviewsResource]
/// - [OrganizationsLocationsOrgPolicyViolationsPreviewsOperationsResource]
/// -
/// [OrganizationsLocationsOrgPolicyViolationsPreviewsOrgPolicyViolationsResource]
/// - [OrganizationsLocationsReplaysResource]
/// - [OrganizationsLocationsReplaysOperationsResource]
/// - [OrganizationsLocationsReplaysResultsResource]
/// - [ProjectsResource]
/// - [ProjectsLocationsResource]
/// - [ProjectsLocationsAccessPolicySimulationsResource]
/// - [ProjectsLocationsAccessPolicySimulationsOperationsResource]
/// - [ProjectsLocationsOrgPolicyViolationsPreviewsResource]
/// - [ProjectsLocationsOrgPolicyViolationsPreviewsOperationsResource]
/// - [ProjectsLocationsReplaysResource]
/// - [ProjectsLocationsReplaysOperationsResource]
/// - [ProjectsLocationsReplaysResultsResource]
library;
import 'dart:async' as async;
import 'dart:convert' as convert;
import 'dart:core' as core;
import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
import 'package:http/http.dart' as http;
import '../shared.dart';
import '../src/user_agent.dart';
export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
show ApiRequestError, DetailedApiRequestError;
/// Policy Simulator is a collection of endpoints for creating, running, and
/// viewing a Replay.
///
/// A `Replay` is a type of simulation that lets you see how your members'
/// access to resources might change if you changed your IAM policy. During a
/// `Replay`, Policy Simulator re-evaluates, or replays, past access attempts
/// under both the current policy and your proposed policy, and compares those
/// results to determine how your members' access might change under the
/// proposed policy.
class PolicySimulatorApi {
/// See, edit, configure, and delete your Google Cloud data and see the email
/// address for your Google Account.
static const cloudPlatformScope =
'https://www.googleapis.com/auth/cloud-platform';
final commons.ApiRequester _requester;
FoldersResource get folders => FoldersResource(_requester);
OperationsResource get operations => OperationsResource(_requester);
OrganizationsResource get organizations => OrganizationsResource(_requester);
ProjectsResource get projects => ProjectsResource(_requester);
PolicySimulatorApi(
http.Client client, {
core.String rootUrl = 'https://policysimulator.googleapis.com/',
core.String servicePath = '',
}) : _requester = commons.ApiRequester(
client,
rootUrl,
servicePath,
requestHeaders,
);
}
class FoldersResource {
final commons.ApiRequester _requester;
FoldersLocationsResource get locations =>
FoldersLocationsResource(_requester);
FoldersResource(commons.ApiRequester client) : _requester = client;
}
class FoldersLocationsResource {
final commons.ApiRequester _requester;
FoldersLocationsAccessPolicySimulationsResource get accessPolicySimulations =>
FoldersLocationsAccessPolicySimulationsResource(_requester);
FoldersLocationsOrgPolicyViolationsPreviewsResource
get orgPolicyViolationsPreviews =>
FoldersLocationsOrgPolicyViolationsPreviewsResource(_requester);
FoldersLocationsReplaysResource get replays =>
FoldersLocationsReplaysResource(_requester);
FoldersLocationsResource(commons.ApiRequester client) : _requester = client;
}
class FoldersLocationsAccessPolicySimulationsResource {
final commons.ApiRequester _requester;
FoldersLocationsAccessPolicySimulationsOperationsResource get operations =>
FoldersLocationsAccessPolicySimulationsOperationsResource(_requester);
FoldersLocationsAccessPolicySimulationsResource(commons.ApiRequester client)
: _requester = client;
}
class FoldersLocationsAccessPolicySimulationsOperationsResource {
final commons.ApiRequester _requester;
FoldersLocationsAccessPolicySimulationsOperationsResource(
commons.ApiRequester client,
) : _requester = client;
/// 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.
///
/// Request parameters:
///
/// [name] - The name of the operation resource.
/// Value must have pattern
/// `^folders/\[^/\]+/locations/\[^/\]+/accessPolicySimulations/\[^/\]+/operations/.*$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningOperation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningOperation> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class FoldersLocationsOrgPolicyViolationsPreviewsResource {
final commons.ApiRequester _requester;
FoldersLocationsOrgPolicyViolationsPreviewsOperationsResource
get operations =>
FoldersLocationsOrgPolicyViolationsPreviewsOperationsResource(_requester);
FoldersLocationsOrgPolicyViolationsPreviewsResource(
commons.ApiRequester client,
) : _requester = client;
}
class FoldersLocationsOrgPolicyViolationsPreviewsOperationsResource {
final commons.ApiRequester _requester;
FoldersLocationsOrgPolicyViolationsPreviewsOperationsResource(
commons.ApiRequester client,
) : _requester = client;
/// 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.
///
/// Request parameters:
///
/// [name] - The name of the operation resource.
/// Value must have pattern
/// `^folders/\[^/\]+/locations/\[^/\]+/orgPolicyViolationsPreviews/\[^/\]+/operations/.*$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningOperation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningOperation> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class FoldersLocationsReplaysResource {
final commons.ApiRequester _requester;
FoldersLocationsReplaysOperationsResource get operations =>
FoldersLocationsReplaysOperationsResource(_requester);
FoldersLocationsReplaysResultsResource get results =>
FoldersLocationsReplaysResultsResource(_requester);
FoldersLocationsReplaysResource(commons.ApiRequester client)
: _requester = client;
/// Creates and starts a Replay using the given ReplayConfig.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The parent resource where this Replay will be
/// created. This resource must be a project, folder, or organization with a
/// location. Example: `projects/my-example-project/locations/global`
/// Value must have pattern `^folders/\[^/\]+/locations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningOperation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningOperation> create(
GoogleCloudPolicysimulatorV1Replay request,
core.String parent, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/replays';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Gets the specified Replay.
///
/// Each `Replay` is available for at least 7 days.
///
/// Request parameters:
///
/// [name] - Required. The name of the Replay to retrieve, in the following
/// format:
/// `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`,
/// where `{resource-id}` is the ID of the project, folder, or organization
/// that owns the `Replay`. Example:
/// `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
/// Value must have pattern
/// `^folders/\[^/\]+/locations/\[^/\]+/replays/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleCloudPolicysimulatorV1Replay].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleCloudPolicysimulatorV1Replay> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudPolicysimulatorV1Replay.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class FoldersLocationsReplaysOperationsResource {
final commons.ApiRequester _requester;
FoldersLocationsReplaysOperationsResource(commons.ApiRequester client)
: _requester = client;
/// 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.
///
/// Request parameters:
///
/// [name] - The name of the operation resource.
/// Value must have pattern
/// `^folders/\[^/\]+/locations/\[^/\]+/replays/\[^/\]+/operations/.*$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningOperation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningOperation> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Lists operations that match the specified filter in the request.
///
/// If the server doesn't support this method, it returns `UNIMPLEMENTED`.
///
/// Request parameters:
///
/// [name] - The name of the operation's parent resource.
/// Value must have pattern
/// `^folders/\[^/\]+/locations/\[^/\]+/replays/\[^/\]+/operations$`.
///
/// [filter] - The standard list filter.
///
/// [pageSize] - The standard list page size.
///
/// [pageToken] - The standard list page token.
///
/// [returnPartialSuccess] - 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] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningListOperationsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningListOperationsResponse> list(
core.String name, {
core.String? filter,
core.int? pageSize,
core.String? pageToken,
core.bool? returnPartialSuccess,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'filter': ?filter == null ? null : [filter],
'pageSize': ?pageSize == null ? null : ['${pageSize}'],
'pageToken': ?pageToken == null ? null : [pageToken],
'returnPartialSuccess': ?returnPartialSuccess == null
? null
: ['${returnPartialSuccess}'],
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleLongrunningListOperationsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class FoldersLocationsReplaysResultsResource {
final commons.ApiRequester _requester;
FoldersLocationsReplaysResultsResource(commons.ApiRequester client)
: _requester = client;
/// Lists the results of running a Replay.
///
/// Request parameters:
///
/// [parent] - Required. The Replay whose results are listed, in the following
/// format:
/// `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`
/// Example:
/// `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
/// Value must have pattern
/// `^folders/\[^/\]+/locations/\[^/\]+/replays/\[^/\]+$`.
///
/// [pageSize] - The maximum number of ReplayResult objects to return.
/// Defaults to 5000. The maximum value is 5000; values above 5000 are rounded
/// down to 5000.
///
/// [pageToken] - A page token, received from a previous
/// Simulator.ListReplayResults call. Provide this token to retrieve the next
/// page of results. When paginating, all other parameters provided to
/// \[Simulator.ListReplayResults\[\] must match the call that provided the
/// page token.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleCloudPolicysimulatorV1ListReplayResultsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleCloudPolicysimulatorV1ListReplayResultsResponse> list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'pageSize': ?pageSize == null ? null : ['${pageSize}'],
'pageToken': ?pageToken == null ? null : [pageToken],
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/results';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudPolicysimulatorV1ListReplayResultsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class OperationsResource {
final commons.ApiRequester _requester;
OperationsResource(commons.ApiRequester client) : _requester = client;
/// 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.
///
/// Request parameters:
///
/// [name] - The name of the operation resource.
/// Value must have pattern `^operations/.*$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningOperation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningOperation> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Lists operations that match the specified filter in the request.
///
/// If the server doesn't support this method, it returns `UNIMPLEMENTED`.
///
/// Request parameters:
///
/// [name] - The name of the operation's parent resource.
/// Value must have pattern `^operations$`.
///
/// [filter] - The standard list filter.
///
/// [pageSize] - The standard list page size.
///
/// [pageToken] - The standard list page token.
///
/// [returnPartialSuccess] - 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] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningListOperationsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningListOperationsResponse> list(
core.String name, {
core.String? filter,
core.int? pageSize,
core.String? pageToken,
core.bool? returnPartialSuccess,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'filter': ?filter == null ? null : [filter],
'pageSize': ?pageSize == null ? null : ['${pageSize}'],
'pageToken': ?pageToken == null ? null : [pageToken],
'returnPartialSuccess': ?returnPartialSuccess == null
? null
: ['${returnPartialSuccess}'],
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleLongrunningListOperationsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class OrganizationsResource {
final commons.ApiRequester _requester;
OrganizationsLocationsResource get locations =>
OrganizationsLocationsResource(_requester);
OrganizationsResource(commons.ApiRequester client) : _requester = client;
}
class OrganizationsLocationsResource {
final commons.ApiRequester _requester;
OrganizationsLocationsAccessPolicySimulationsResource
get accessPolicySimulations =>
OrganizationsLocationsAccessPolicySimulationsResource(_requester);
OrganizationsLocationsOrgPolicyViolationsPreviewsResource
get orgPolicyViolationsPreviews =>
OrganizationsLocationsOrgPolicyViolationsPreviewsResource(_requester);
OrganizationsLocationsReplaysResource get replays =>
OrganizationsLocationsReplaysResource(_requester);
OrganizationsLocationsResource(commons.ApiRequester client)
: _requester = client;
}
class OrganizationsLocationsAccessPolicySimulationsResource {
final commons.ApiRequester _requester;
OrganizationsLocationsAccessPolicySimulationsOperationsResource
get operations =>
OrganizationsLocationsAccessPolicySimulationsOperationsResource(
_requester,
);
OrganizationsLocationsAccessPolicySimulationsResource(
commons.ApiRequester client,
) : _requester = client;
}
class OrganizationsLocationsAccessPolicySimulationsOperationsResource {
final commons.ApiRequester _requester;
OrganizationsLocationsAccessPolicySimulationsOperationsResource(
commons.ApiRequester client,
) : _requester = client;
/// 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.
///
/// Request parameters:
///
/// [name] - The name of the operation resource.
/// Value must have pattern
/// `^organizations/\[^/\]+/locations/\[^/\]+/accessPolicySimulations/\[^/\]+/operations/.*$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningOperation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningOperation> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class OrganizationsLocationsOrgPolicyViolationsPreviewsResource {
final commons.ApiRequester _requester;
OrganizationsLocationsOrgPolicyViolationsPreviewsOperationsResource
get operations =>
OrganizationsLocationsOrgPolicyViolationsPreviewsOperationsResource(
_requester,
);
OrganizationsLocationsOrgPolicyViolationsPreviewsOrgPolicyViolationsResource
get orgPolicyViolations =>
OrganizationsLocationsOrgPolicyViolationsPreviewsOrgPolicyViolationsResource(
_requester,
);
OrganizationsLocationsOrgPolicyViolationsPreviewsResource(
commons.ApiRequester client,
) : _requester = client;
/// CreateOrgPolicyViolationsPreview creates an OrgPolicyViolationsPreview for
/// the proposed changes in the provided
/// OrgPolicyViolationsPreview.OrgPolicyOverlay.
///
/// The changes to OrgPolicy are specified by this `OrgPolicyOverlay`. The
/// resources to scan are inferred from these specified changes.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The organization under which this
/// OrgPolicyViolationsPreview will be created. Example:
/// `organizations/my-example-org/locations/global`
/// Value must have pattern `^organizations/\[^/\]+/locations/\[^/\]+$`.
///
/// [orgPolicyViolationsPreviewId] - Optional. An optional user-specified ID
/// for the OrgPolicyViolationsPreview. If not provided, a random ID will be
/// generated.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningOperation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningOperation> create(
GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview request,
core.String parent, {
core.String? orgPolicyViolationsPreviewId,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
'orgPolicyViolationsPreviewId': ?orgPolicyViolationsPreviewId == null
? null
: [orgPolicyViolationsPreviewId],
'fields': ?$fields == null ? null : [$fields],
};
final url_ =
'v1/' + core.Uri.encodeFull('$parent') + '/orgPolicyViolationsPreviews';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// GetOrgPolicyViolationsPreview gets the specified
/// OrgPolicyViolationsPreview.
///
/// Each OrgPolicyViolationsPreview is available for at least 7 days.
///
/// Request parameters:
///
/// [name] - Required. The name of the OrgPolicyViolationsPreview to get.
/// Value must have pattern
/// `^organizations/\[^/\]+/locations/\[^/\]+/orgPolicyViolationsPreviews/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// ListOrgPolicyViolationsPreviews lists each OrgPolicyViolationsPreview in
/// an organization.
///
/// Each OrgPolicyViolationsPreview is available for at least 7 days.
///
/// Request parameters:
///
/// [parent] - Required. The parent the violations are scoped to. Format:
/// `organizations/{organization}/locations/{location}` Example:
/// `organizations/my-example-org/locations/global`
/// Value must have pattern `^organizations/\[^/\]+/locations/\[^/\]+$`.
///
/// [pageSize] - Optional. The maximum number of items to return. The service
/// may return fewer than this value. If unspecified, at most 5 items will be
/// returned. The maximum value is 10; values above 10 will be coerced to 10.
///
/// [pageToken] - Optional. A page token, received from a previous call.
/// Provide this to retrieve the subsequent page. When paginating, all other
/// parameters must match the call that provided the page token.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a
/// [GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<
GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse
>
list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'pageSize': ?pageSize == null ? null : ['${pageSize}'],
'pageToken': ?pageToken == null ? null : [pageToken],
'fields': ?$fields == null ? null : [$fields],
};
final url_ =
'v1/' + core.Uri.encodeFull('$parent') + '/orgPolicyViolationsPreviews';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class OrganizationsLocationsOrgPolicyViolationsPreviewsOperationsResource {
final commons.ApiRequester _requester;
OrganizationsLocationsOrgPolicyViolationsPreviewsOperationsResource(
commons.ApiRequester client,
) : _requester = client;
/// 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.
///
/// Request parameters:
///
/// [name] - The name of the operation resource.
/// Value must have pattern
/// `^organizations/\[^/\]+/locations/\[^/\]+/orgPolicyViolationsPreviews/\[^/\]+/operations/.*$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningOperation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningOperation> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class OrganizationsLocationsOrgPolicyViolationsPreviewsOrgPolicyViolationsResource {
final commons.ApiRequester _requester;
OrganizationsLocationsOrgPolicyViolationsPreviewsOrgPolicyViolationsResource(
commons.ApiRequester client,
) : _requester = client;
/// ListOrgPolicyViolations lists the OrgPolicyViolations that are present in
/// an OrgPolicyViolationsPreview.
///
/// Request parameters:
///
/// [parent] - Required. The OrgPolicyViolationsPreview to get
/// OrgPolicyViolations from. Format:
/// organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}
/// Value must have pattern
/// `^organizations/\[^/\]+/locations/\[^/\]+/orgPolicyViolationsPreviews/\[^/\]+$`.
///
/// [pageSize] - Optional. The maximum number of items to return. The service
/// may return fewer than this value. If unspecified, at most 1000 items will
/// be returned. The maximum value is 1000; values above 1000 will be coerced
/// to 1000.
///
/// [pageToken] - Optional. A page token, received from a previous call.
/// Provide this to retrieve the subsequent page. When paginating, all other
/// parameters must match the call that provided the page token.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a
/// [GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse>
list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'pageSize': ?pageSize == null ? null : ['${pageSize}'],
'pageToken': ?pageToken == null ? null : [pageToken],
'fields': ?$fields == null ? null : [$fields],
};
final url_ =
'v1/' + core.Uri.encodeFull('$parent') + '/orgPolicyViolations';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class OrganizationsLocationsReplaysResource {
final commons.ApiRequester _requester;
OrganizationsLocationsReplaysOperationsResource get operations =>
OrganizationsLocationsReplaysOperationsResource(_requester);
OrganizationsLocationsReplaysResultsResource get results =>
OrganizationsLocationsReplaysResultsResource(_requester);
OrganizationsLocationsReplaysResource(commons.ApiRequester client)
: _requester = client;
/// Creates and starts a Replay using the given ReplayConfig.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The parent resource where this Replay will be
/// created. This resource must be a project, folder, or organization with a
/// location. Example: `projects/my-example-project/locations/global`
/// Value must have pattern `^organizations/\[^/\]+/locations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningOperation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningOperation> create(
GoogleCloudPolicysimulatorV1Replay request,
core.String parent, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/replays';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Gets the specified Replay.
///
/// Each `Replay` is available for at least 7 days.
///
/// Request parameters:
///
/// [name] - Required. The name of the Replay to retrieve, in the following
/// format:
/// `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`,
/// where `{resource-id}` is the ID of the project, folder, or organization
/// that owns the `Replay`. Example:
/// `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
/// Value must have pattern
/// `^organizations/\[^/\]+/locations/\[^/\]+/replays/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleCloudPolicysimulatorV1Replay].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleCloudPolicysimulatorV1Replay> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudPolicysimulatorV1Replay.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class OrganizationsLocationsReplaysOperationsResource {
final commons.ApiRequester _requester;
OrganizationsLocationsReplaysOperationsResource(commons.ApiRequester client)
: _requester = client;
/// 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.
///
/// Request parameters:
///
/// [name] - The name of the operation resource.
/// Value must have pattern
/// `^organizations/\[^/\]+/locations/\[^/\]+/replays/\[^/\]+/operations/.*$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningOperation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningOperation> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Lists operations that match the specified filter in the request.
///
/// If the server doesn't support this method, it returns `UNIMPLEMENTED`.
///
/// Request parameters:
///
/// [name] - The name of the operation's parent resource.
/// Value must have pattern
/// `^organizations/\[^/\]+/locations/\[^/\]+/replays/\[^/\]+/operations$`.
///
/// [filter] - The standard list filter.
///
/// [pageSize] - The standard list page size.
///
/// [pageToken] - The standard list page token.
///
/// [returnPartialSuccess] - 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] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningListOperationsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningListOperationsResponse> list(
core.String name, {
core.String? filter,
core.int? pageSize,
core.String? pageToken,
core.bool? returnPartialSuccess,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'filter': ?filter == null ? null : [filter],
'pageSize': ?pageSize == null ? null : ['${pageSize}'],
'pageToken': ?pageToken == null ? null : [pageToken],
'returnPartialSuccess': ?returnPartialSuccess == null
? null
: ['${returnPartialSuccess}'],
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleLongrunningListOperationsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class OrganizationsLocationsReplaysResultsResource {
final commons.ApiRequester _requester;
OrganizationsLocationsReplaysResultsResource(commons.ApiRequester client)
: _requester = client;
/// Lists the results of running a Replay.
///
/// Request parameters:
///
/// [parent] - Required. The Replay whose results are listed, in the following
/// format:
/// `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`
/// Example:
/// `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
/// Value must have pattern
/// `^organizations/\[^/\]+/locations/\[^/\]+/replays/\[^/\]+$`.
///
/// [pageSize] - The maximum number of ReplayResult objects to return.
/// Defaults to 5000. The maximum value is 5000; values above 5000 are rounded
/// down to 5000.
///
/// [pageToken] - A page token, received from a previous
/// Simulator.ListReplayResults call. Provide this token to retrieve the next
/// page of results. When paginating, all other parameters provided to
/// \[Simulator.ListReplayResults\[\] must match the call that provided the
/// page token.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleCloudPolicysimulatorV1ListReplayResultsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleCloudPolicysimulatorV1ListReplayResultsResponse> list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'pageSize': ?pageSize == null ? null : ['${pageSize}'],
'pageToken': ?pageToken == null ? null : [pageToken],
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/results';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudPolicysimulatorV1ListReplayResultsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class ProjectsResource {
final commons.ApiRequester _requester;
ProjectsLocationsResource get locations =>
ProjectsLocationsResource(_requester);
ProjectsResource(commons.ApiRequester client) : _requester = client;
}
class ProjectsLocationsResource {
final commons.ApiRequester _requester;
ProjectsLocationsAccessPolicySimulationsResource
get accessPolicySimulations =>
ProjectsLocationsAccessPolicySimulationsResource(_requester);
ProjectsLocationsOrgPolicyViolationsPreviewsResource
get orgPolicyViolationsPreviews =>
ProjectsLocationsOrgPolicyViolationsPreviewsResource(_requester);
ProjectsLocationsReplaysResource get replays =>
ProjectsLocationsReplaysResource(_requester);
ProjectsLocationsResource(commons.ApiRequester client) : _requester = client;
}
class ProjectsLocationsAccessPolicySimulationsResource {
final commons.ApiRequester _requester;
ProjectsLocationsAccessPolicySimulationsOperationsResource get operations =>
ProjectsLocationsAccessPolicySimulationsOperationsResource(_requester);
ProjectsLocationsAccessPolicySimulationsResource(commons.ApiRequester client)
: _requester = client;
}
class ProjectsLocationsAccessPolicySimulationsOperationsResource {
final commons.ApiRequester _requester;
ProjectsLocationsAccessPolicySimulationsOperationsResource(
commons.ApiRequester client,
) : _requester = client;
/// 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.
///
/// Request parameters:
///
/// [name] - The name of the operation resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/accessPolicySimulations/\[^/\]+/operations/.*$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningOperation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningOperation> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class ProjectsLocationsOrgPolicyViolationsPreviewsResource {
final commons.ApiRequester _requester;
ProjectsLocationsOrgPolicyViolationsPreviewsOperationsResource
get operations =>
ProjectsLocationsOrgPolicyViolationsPreviewsOperationsResource(
_requester,
);
ProjectsLocationsOrgPolicyViolationsPreviewsResource(
commons.ApiRequester client,
) : _requester = client;
}
class ProjectsLocationsOrgPolicyViolationsPreviewsOperationsResource {
final commons.ApiRequester _requester;
ProjectsLocationsOrgPolicyViolationsPreviewsOperationsResource(
commons.ApiRequester client,
) : _requester = client;
/// 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.
///
/// Request parameters:
///
/// [name] - The name of the operation resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/orgPolicyViolationsPreviews/\[^/\]+/operations/.*$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningOperation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningOperation> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class ProjectsLocationsReplaysResource {
final commons.ApiRequester _requester;
ProjectsLocationsReplaysOperationsResource get operations =>
ProjectsLocationsReplaysOperationsResource(_requester);
ProjectsLocationsReplaysResultsResource get results =>
ProjectsLocationsReplaysResultsResource(_requester);
ProjectsLocationsReplaysResource(commons.ApiRequester client)
: _requester = client;
/// Creates and starts a Replay using the given ReplayConfig.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The parent resource where this Replay will be
/// created. This resource must be a project, folder, or organization with a
/// location. Example: `projects/my-example-project/locations/global`
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningOperation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningOperation> create(
GoogleCloudPolicysimulatorV1Replay request,
core.String parent, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/replays';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Gets the specified Replay.
///
/// Each `Replay` is available for at least 7 days.
///
/// Request parameters:
///
/// [name] - Required. The name of the Replay to retrieve, in the following
/// format:
/// `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`,
/// where `{resource-id}` is the ID of the project, folder, or organization
/// that owns the `Replay`. Example:
/// `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/replays/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleCloudPolicysimulatorV1Replay].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleCloudPolicysimulatorV1Replay> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudPolicysimulatorV1Replay.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class ProjectsLocationsReplaysOperationsResource {
final commons.ApiRequester _requester;
ProjectsLocationsReplaysOperationsResource(commons.ApiRequester client)
: _requester = client;
/// 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.
///
/// Request parameters:
///
/// [name] - The name of the operation resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/replays/\[^/\]+/operations/.*$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningOperation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningOperation> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
/// Lists operations that match the specified filter in the request.
///
/// If the server doesn't support this method, it returns `UNIMPLEMENTED`.
///
/// Request parameters:
///
/// [name] - The name of the operation's parent resource.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/replays/\[^/\]+/operations$`.
///
/// [filter] - The standard list filter.
///
/// [pageSize] - The standard list page size.
///
/// [pageToken] - The standard list page token.
///
/// [returnPartialSuccess] - 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] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleLongrunningListOperationsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleLongrunningListOperationsResponse> list(
core.String name, {
core.String? filter,
core.int? pageSize,
core.String? pageToken,
core.bool? returnPartialSuccess,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'filter': ?filter == null ? null : [filter],
'pageSize': ?pageSize == null ? null : ['${pageSize}'],
'pageToken': ?pageToken == null ? null : [pageToken],
'returnPartialSuccess': ?returnPartialSuccess == null
? null
: ['${returnPartialSuccess}'],
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleLongrunningListOperationsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
class ProjectsLocationsReplaysResultsResource {
final commons.ApiRequester _requester;
ProjectsLocationsReplaysResultsResource(commons.ApiRequester client)
: _requester = client;
/// Lists the results of running a Replay.
///
/// Request parameters:
///
/// [parent] - Required. The Replay whose results are listed, in the following
/// format:
/// `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`
/// Example:
/// `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/replays/\[^/\]+$`.
///
/// [pageSize] - The maximum number of ReplayResult objects to return.
/// Defaults to 5000. The maximum value is 5000; values above 5000 are rounded
/// down to 5000.
///
/// [pageToken] - A page token, received from a previous
/// Simulator.ListReplayResults call. Provide this token to retrieve the next
/// page of results. When paginating, all other parameters provided to
/// \[Simulator.ListReplayResults\[\] must match the call that provided the
/// page token.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [GoogleCloudPolicysimulatorV1ListReplayResultsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<GoogleCloudPolicysimulatorV1ListReplayResultsResponse> list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
'pageSize': ?pageSize == null ? null : ['${pageSize}'],
'pageToken': ?pageToken == null ? null : [pageToken],
'fields': ?$fields == null ? null : [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/results';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudPolicysimulatorV1ListReplayResultsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}
}
/// Similar to PolicySpec but with an extra 'launch' field for launch reference.
///
/// The PolicySpec here is specific for dry-run.
class GoogleCloudOrgpolicyV2AlternatePolicySpec {
/// Reference to the launch that will be used while audit logging and to
/// control the launch.
///
/// Set only in the alternate policy.
core.String? launch;
/// Specify constraint for configurations of Google Cloud resources.
GoogleCloudOrgpolicyV2PolicySpec? spec;
GoogleCloudOrgpolicyV2AlternatePolicySpec({this.launch, this.spec});
GoogleCloudOrgpolicyV2AlternatePolicySpec.fromJson(core.Map json_)
: this(
launch: json_['launch'] as core.String?,
spec: json_.containsKey('spec')
? GoogleCloudOrgpolicyV2PolicySpec.fromJson(
json_['spec'] as core.Map<core.String, core.dynamic>,
)
: null,
);
core.Map<core.String, core.dynamic> toJson() {
final launch = this.launch;
final spec = this.spec;
return {'launch': ?launch, 'spec': ?spec};
}
}
/// A custom constraint defined by customers which can *only* be applied to the
/// given resource types and organization.
///
/// By creating a custom constraint, customers can apply policies of this custom
/// constraint. *Creating a custom constraint itself does NOT apply any policy
/// enforcement*.
class GoogleCloudOrgpolicyV2CustomConstraint {
/// Allow or deny type.
/// Possible string values are:
/// - "ACTION_TYPE_UNSPECIFIED" : This is only used for distinguishing unset
/// values, and results in an error if used.
/// - "ALLOW" : Allowed action type.
/// - "DENY" : Deny action type.
core.String? actionType;
/// A Common Expression Language (CEL) condition which is used in the
/// evaluation of the constraint.
///
/// For example:
/// `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or,
/// `resource.management.auto_upgrade == true` The max length of the condition
/// is 1000 characters.
core.String? condition;
/// Detailed information about this custom policy constraint.
///
/// The max length of the description is 2000 characters.
core.String? description;
/// One line display name for the UI.
///
/// The max length of the display_name is 200 characters.
core.String? displayName;
/// All the operations being applied for this constraint.
core.List<core.String>? methodTypes;
/// Name of the constraint.
///
/// This is unique within the organization. The name must be of the form: *
/// `organizations/{organization_id}/customConstraints/{custom_constraint_id}`
/// Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`
/// The max length is 71 characters and the minimum length is 1. Note that the
/// prefix `organizations/{organization_id}/customConstraints/custom.` is not
/// counted.
///
/// Immutable.
core.String? name;
/// The resource instance type on which this policy applies.
///
/// Format will be of the form : `/` Example: *
/// `compute.googleapis.com/Instance`.
///
/// Immutable.
core.List<core.String>? resourceTypes;
/// The last time this custom constraint was updated.
///
/// This represents the last time that the `CreateCustomConstraint` or
/// `UpdateCustomConstraint` methods were called.
///
/// Output only.
core.String? updateTime;
GoogleCloudOrgpolicyV2CustomConstraint({
this.actionType,
this.condition,
this.description,
this.displayName,
this.methodTypes,
this.name,
this.resourceTypes,
this.updateTime,
});
GoogleCloudOrgpolicyV2CustomConstraint.fromJson(core.Map json_)
: this(
actionType: json_['actionType'] as core.String?,
condition: json_['condition'] as core.String?,
description: json_['description'] as core.String?,
displayName: json_['displayName'] as core.String?,
methodTypes: (json_['methodTypes'] as core.List?)
?.map((value) => value as core.String)
.toList(),
name: json_['name'] as core.String?,
resourceTypes: (json_['resourceTypes'] as core.List?)
?.map((value) => value as core.String)
.toList(),
updateTime: json_['updateTime'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() {
final actionType = this.actionType;
final condition = this.condition;
final description = this.description;
final displayName = this.displayName;
final methodTypes = this.methodTypes;
final name = this.name;
final resourceTypes = this.resourceTypes;
final updateTime = this.updateTime;
return {
'actionType': ?actionType,
'condition': ?condition,
'description': ?description,
'displayName': ?displayName,
'methodTypes': ?methodTypes,
'name': ?name,
'resourceTypes': ?resourceTypes,
'updateTime': ?updateTime,
};
}
}
/// Defines an organization policy that is used to specify constraints for
/// configurations of Google Cloud resources.
class GoogleCloudOrgpolicyV2Policy {
/// Deprecated.
@core.Deprecated(
'Not supported. Member documentation may have more information.',
)
GoogleCloudOrgpolicyV2AlternatePolicySpec? alternate;
/// Dry-run policy.
///
/// Audit-only policy, can be used to monitor how the policy would have
/// impacted the existing and future resources if it's enforced.
GoogleCloudOrgpolicyV2PolicySpec? dryRunSpec;
/// An opaque tag indicating the current state of the policy, used for
/// concurrency control.
///
/// This entity tag (ETag) is computed by the server based on the value of
/// other fields, and may be sent on update and delete requests to ensure the
/// client has an up-to-date value before proceeding.
///
/// Optional.
core.String? etag;
/// The resource name of the policy.
///
/// Must be one of the following forms, where `constraint_name` is the name of
/// the constraint that this policy configures: *
/// `projects/{project_number}/policies/{constraint_name}` *
/// `folders/{folder_id}/policies/{constraint_name}` *
/// `organizations/{organization_id}/policies/{constraint_name}` For example,
/// `projects/123/policies/compute.disableSerialPortAccess`. Note:
/// `projects/{project_id}/policies/{constraint_name}` is also an acceptable
/// name for API requests, but responses will return the name using the
/// equivalent project number.
///
/// Immutable.
core.String? name;
/// Basic information about the organization policy.
GoogleCloudOrgpolicyV2PolicySpec? spec;
GoogleCloudOrgpolicyV2Policy({
this.alternate,
this.dryRunSpec,
this.etag,
this.name,
this.spec,
});
GoogleCloudOrgpolicyV2Policy.fromJson(core.Map json_)
: this(
alternate: json_.containsKey('alternate')
? GoogleCloudOrgpolicyV2AlternatePolicySpec.fromJson(
json_['alternate'] as core.Map<core.String, core.dynamic>,
)
: null,
dryRunSpec: json_.containsKey('dryRunSpec')
? GoogleCloudOrgpolicyV2PolicySpec.fromJson(
json_['dryRunSpec'] as core.Map<core.String, core.dynamic>,
)
: null,
etag: json_['etag'] as core.String?,
name: json_['name'] as core.String?,
spec: json_.containsKey('spec')
? GoogleCloudOrgpolicyV2PolicySpec.fromJson(
json_['spec'] as core.Map<core.String, core.dynamic>,
)
: null,
);
core.Map<core.String, core.dynamic> toJson() {
final alternate = this.alternate;
final dryRunSpec = this.dryRunSpec;
final etag = this.etag;
final name = this.name;
final spec = this.spec;
return {
'alternate': ?alternate,
'dryRunSpec': ?dryRunSpec,
'etag': ?etag,
'name': ?name,
'spec': ?spec,
};
}
}
/// Defines a Google Cloud policy specification that is used to specify
/// constraints for configurations of Google Cloud resources.
class GoogleCloudOrgpolicyV2PolicySpec {
/// An opaque tag indicating the current version of the policySpec, used for
/// concurrency control.
///
/// This field is ignored if used in a `CreatePolicy` request. When the policy
/// is returned from either a `GetPolicy` or a `ListPolicies` request, this
/// entity tag (ETag) indicates the version of the current policySpec to use
/// when executing a read-modify-write loop. When the policy is returned from
/// a `GetEffectivePolicy` request, the ETag will be unset.
core.String? etag;
/// Determines the inheritance behavior for this policy.
///
/// If `inherit_from_parent` is true, policy rules set higher up in the
/// hierarchy (up to the closest root) are inherited and present in the
/// effective policy. If it is false, then no rules are inherited, and this
/// policy becomes the new root for evaluation. This field can be set only for
/// policies that configure list constraints.
core.bool? inheritFromParent;
/// Ignores policies set above this resource and restores the
/// `constraint_default` enforcement behavior of the specific constraint at
/// this resource.
///
/// This field can be set in policies for either list or boolean constraints.
/// If set, `rules` must be empty and `inherit_from_parent` must be set to
/// false.
core.bool? reset;
/// In policies for boolean constraints, the following requirements apply: -
/// There must be exactly one policy rule where a condition is unset.
///
/// - Boolean policy rules with conditions must set `enforced` to the opposite
/// of the policy rule without a condition. - During policy evaluation, policy
/// rules with conditions that are true for a target resource take precedence.
core.List<GoogleCloudOrgpolicyV2PolicySpecPolicyRule>? rules;
/// The time stamp this was previously updated.
///
/// This represents the last time a call to `CreatePolicy` or `UpdatePolicy`
/// was made for that policy.
///
/// Output only.
core.String? updateTime;
GoogleCloudOrgpolicyV2PolicySpec({
this.etag,
this.inheritFromParent,
this.reset,
this.rules,
this.updateTime,
});
GoogleCloudOrgpolicyV2PolicySpec.fromJson(core.Map json_)
: this(
etag: json_['etag'] as core.String?,
inheritFromParent: json_['inheritFromParent'] as core.bool?,
reset: json_['reset'] as core.bool?,
rules: (json_['rules'] as core.List?)
?.map(
(value) => GoogleCloudOrgpolicyV2PolicySpecPolicyRule.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
updateTime: json_['updateTime'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() {
final etag = this.etag;
final inheritFromParent = this.inheritFromParent;
final reset = this.reset;
final rules = this.rules;
final updateTime = this.updateTime;
return {
'etag': ?etag,
'inheritFromParent': ?inheritFromParent,
'reset': ?reset,
'rules': ?rules,
'updateTime': ?updateTime,
};
}
}
/// A rule used to express this policy.
class GoogleCloudOrgpolicyV2PolicySpecPolicyRule {
/// Setting this to true means that all values are allowed.
///
/// This field can be set only in policies for list constraints.
core.bool? allowAll;
/// A condition that determines whether this rule is used to evaluate the
/// policy.
///
/// When set, the google.type.Expr.expression field must contain 1 to 10
/// subexpressions, joined by the `||` or `&&` operators. Each subexpression
/// must use the `resource.matchTag()`, `resource.matchTagId()`,
/// `resource.hasTagKey()`, or `resource.hasTagKeyId()` Common Expression
/// Language (CEL) function. The `resource.matchTag()` function takes the
/// following arguments: * `key_name`: the namespaced name of the tag key,
/// with the organization ID and a slash (`/`) as a prefix; for example,
/// `123456789012/environment` * `value_name`: the short name of the tag value
/// For example: `resource.matchTag('123456789012/environment, 'prod')` The
/// `resource.matchTagId()` function takes the following arguments: *
/// `key_id`: the permanent ID of the tag key; for example,
/// `tagKeys/123456789012` * `value_id`: the permanent ID of the tag value;
/// for example, `tagValues/567890123456` For example:
/// `resource.matchTagId('tagKeys/123456789012', 'tagValues/567890123456')`
/// The `resource.hasTagKey()` function takes the following argument: *
/// `key_name`: the namespaced name of the tag key, with the organization ID
/// and a slash (`/`) as a prefix; for example, `123456789012/environment` For
/// example: `resource.hasTagKey('123456789012/environment')` The
/// `resource.hasTagKeyId()` function takes the following arguments: *
/// `key_id`: the permanent ID of the tag key; for example,
/// `tagKeys/123456789012` For example:
/// `resource.hasTagKeyId('tagKeys/123456789012')`
GoogleTypeExpr? condition;
/// Setting this to true means that all values are denied.
///
/// This field can be set only in policies for list constraints.
core.bool? denyAll;
/// If `true`, then the policy is enforced.
///
/// If `false`, then any configuration is acceptable. This field can be set in
/// policies for boolean constraints, custom constraints and managed
/// constraints.
core.bool? enforce;
/// Required for managed constraints if parameters are defined.
///
/// Passes parameter values when policy enforcement is enabled. Ensure that
/// parameter value types match those defined in the constraint definition.
/// For example: ``` { "allowedLocations" : ["us-east1", "us-west1"],
/// "allowAll" : true } ```
///
/// Optional.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object?>? parameters;
/// List of values to be used for this policy rule.
///
/// This field can be set only in policies for list constraints.
GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues? values;
GoogleCloudOrgpolicyV2PolicySpecPolicyRule({
this.allowAll,
this.condition,
this.denyAll,
this.enforce,
this.parameters,
this.values,
});
GoogleCloudOrgpolicyV2PolicySpecPolicyRule.fromJson(core.Map json_)
: this(
allowAll: json_['allowAll'] as core.bool?,
condition: json_.containsKey('condition')
? GoogleTypeExpr.fromJson(
json_['condition'] as core.Map<core.String, core.dynamic>,
)
: null,
denyAll: json_['denyAll'] as core.bool?,
enforce: json_['enforce'] as core.bool?,
parameters: json_.containsKey('parameters')
? json_['parameters'] as core.Map<core.String, core.dynamic>
: null,
values: json_.containsKey('values')
? GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues.fromJson(
json_['values'] as core.Map<core.String, core.dynamic>,
)
: null,
);
core.Map<core.String, core.dynamic> toJson() {
final allowAll = this.allowAll;
final condition = this.condition;
final denyAll = this.denyAll;
final enforce = this.enforce;
final parameters = this.parameters;
final values = this.values;
return {
'allowAll': ?allowAll,
'condition': ?condition,
'denyAll': ?denyAll,
'enforce': ?enforce,
'parameters': ?parameters,
'values': ?values,
};
}
}
/// A message that holds specific allowed and denied values.
///
/// This message can define specific values and subtrees of the Resource Manager
/// resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed
/// or denied. This is achieved by using the `under:` and optional `is:`
/// prefixes. The `under:` prefix is used to denote resource subtree values. The
/// `is:` prefix is used to denote specific values, and is required only if the
/// value contains a ":". Values prefixed with "is:" are treated the same as
/// values with no prefix. Ancestry subtrees must be in one of the following
/// formats: - `projects/` (for example, `projects/tokyo-rain-123`) - `folders/`
/// (for example, `folders/1234`) - `organizations/` (for example,
/// `organizations/1234`) The `supports_under` field of the associated
/// `Constraint` defines whether ancestry prefixes can be used.
typedef GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues = $StringValues;
/// A summary and comparison of the principal's access under the current
/// (baseline) policies and the proposed (simulated) policies for a single
/// access tuple.
class GoogleCloudPolicysimulatorV1AccessStateDiff {
/// How the principal's access, specified in the AccessState field, changed
/// between the current (baseline) policies and proposed (simulated) policies.
/// Possible string values are:
/// - "ACCESS_CHANGE_TYPE_UNSPECIFIED" : Default value. This value is unused.
/// - "NO_CHANGE" : The principal's access did not change. This includes the
/// case where both baseline and simulated are UNKNOWN, but the unknown
/// information is equivalent.
/// - "UNKNOWN_CHANGE" : The principal's access under both the current
/// policies and the proposed policies is `UNKNOWN`, but the unknown
/// information differs between them.
/// - "ACCESS_REVOKED" : The principal had access under the current policies
/// (`GRANTED`), but will no longer have access after the proposed changes
/// (`NOT_GRANTED`).
/// - "ACCESS_GAINED" : The principal did not have access under the current
/// policies (`NOT_GRANTED`), but will have access after the proposed changes
/// (`GRANTED`).
/// - "ACCESS_MAYBE_REVOKED" : This result can occur for the following
/// reasons: * The principal had access under the current policies
/// (`GRANTED`), but their access after the proposed changes is `UNKNOWN`. *
/// The principal's access under the current policies is `UNKNOWN`, but they
/// will not have access after the proposed changes (`NOT_GRANTED`).
/// - "ACCESS_MAYBE_GAINED" : This result can occur for the following reasons:
/// * The principal did not have access under the current policies
/// (`NOT_GRANTED`), but their access after the proposed changes is `UNKNOWN`.
/// * The principal's access under the current policies is `UNKNOWN`, but they
/// will have access after the proposed changes (`GRANTED`).
core.String? accessChange;
/// The results of evaluating the access tuple under the current (baseline)
/// policies.
///
/// If the AccessState couldn't be fully evaluated, this field explains why.
GoogleCloudPolicysimulatorV1ExplainedAccess? baseline;
/// The results of evaluating the access tuple under the proposed (simulated)
/// policies.
///
/// If the AccessState couldn't be fully evaluated, this field explains why.
GoogleCloudPolicysimulatorV1ExplainedAccess? simulated;
GoogleCloudPolicysimulatorV1AccessStateDiff({
this.accessChange,
this.baseline,
this.simulated,
});
GoogleCloudPolicysimulatorV1AccessStateDiff.fromJson(core.Map json_)
: this(
accessChange: json_['accessChange'] as core.String?,
baseline: json_.containsKey('baseline')
? GoogleCloudPolicysimulatorV1ExplainedAccess.fromJson(
json_['baseline'] as core.Map<core.String, core.dynamic>,
)
: null,
simulated: json_.containsKey('simulated')
? GoogleCloudPolicysimulatorV1ExplainedAccess.fromJson(
json_['simulated'] as core.Map<core.String, core.dynamic>,
)
: null,
);
core.Map<core.String, core.dynamic> toJson() {
final accessChange = this.accessChange;
final baseline = this.baseline;
final simulated = this.simulated;
return {
'accessChange': ?accessChange,
'baseline': ?baseline,
'simulated': ?simulated,
};
}
}
/// Information about the principal, resource, and permission to check.
typedef GoogleCloudPolicysimulatorV1AccessTuple = $V1AccessTuple;
/// Details about how a binding in a policy affects a principal's ability to use
/// a permission.
class GoogleCloudPolicysimulatorV1BindingExplanation {
/// Indicates whether _this binding_ provides the specified permission to the
/// specified principal for the specified resource.
///
/// This field does _not_ indicate whether the principal actually has the
/// permission for the resource. There might be another binding that overrides
/// this binding. To determine whether the principal actually has the
/// permission, use the `access` field in the TroubleshootIamPolicyResponse.
///
/// Required.
/// Possible string values are:
/// - "ACCESS_STATE_UNSPECIFIED" : Default value. This value is unused.
/// - "GRANTED" : The principal has the permission.
/// - "NOT_GRANTED" : The principal does not have the permission.
/// - "UNKNOWN_CONDITIONAL" : The principal has the permission only if a
/// condition expression evaluates to `true`.
/// - "UNKNOWN_INFO_DENIED" : The user who created the Replay does not have
/// access to all of the policies that Policy Simulator needs to evaluate.
core.String? access;
/// A condition expression that prevents this binding from granting access
/// unless the expression evaluates to `true`.
///
/// To learn about IAM Conditions, see
/// https://cloud.google.com/iam/docs/conditions-overview.
GoogleTypeExpr? condition;
/// Indicates whether each principal in the binding includes the principal
/// specified in the request, either directly or indirectly.
///
/// Each key identifies a principal in the binding, and each value indicates
/// whether the principal in the binding includes the principal in the
/// request. For example, suppose that a binding includes the following
/// principals: * `user:alice@example.com` * `group:product-eng@example.com`
/// The principal in the replayed access tuple is `user:bob@example.com`. This
/// user is a principal of the group `group:product-eng@example.com`. For the
/// first principal in the binding, the key is `user:alice@example.com`, and
/// the `membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`.
/// For the second principal in the binding, the key is
/// `group:product-eng@example.com`, and the `membership` field in the value
/// is set to `MEMBERSHIP_INCLUDED`.
core.Map<
core.String,
GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership
>?
memberships;
/// The relevance of this binding to the overall determination for the entire
/// policy.
/// Possible string values are:
/// - "HEURISTIC_RELEVANCE_UNSPECIFIED" : Default value. This value is unused.
/// - "NORMAL" : The data point has a limited effect on the result. Changing
/// the data point is unlikely to affect the overall determination.
/// - "HIGH" : The data point has a strong effect on the result. Changing the
/// data point is likely to affect the overall determination.
core.String? relevance;
/// The role that this binding grants.
///
/// For example, `roles/compute.serviceAgent`. For a complete list of
/// predefined IAM roles, as well as the permissions in each role, see
/// https://cloud.google.com/iam/help/roles/reference.
core.String? role;
/// Indicates whether the role granted by this binding contains the specified
/// permission.
/// Possible string values are:
/// - "ROLE_PERMISSION_UNSPECIFIED" : Default value. This value is unused.
/// - "ROLE_PERMISSION_INCLUDED" : The permission is included in the role.
/// - "ROLE_PERMISSION_NOT_INCLUDED" : The permission is not included in the
/// role.
/// - "ROLE_PERMISSION_UNKNOWN_INFO_DENIED" : The user who created the Replay
/// is not allowed to access the binding.
core.String? rolePermission;
/// The relevance of the permission's existence, or nonexistence, in the role
/// to the overall determination for the entire policy.
/// Possible string values are:
/// - "HEURISTIC_RELEVANCE_UNSPECIFIED" : Default value. This value is unused.
/// - "NORMAL" : The data point has a limited effect on the result. Changing
/// the data point is unlikely to affect the overall determination.
/// - "HIGH" : The data point has a strong effect on the result. Changing the
/// data point is likely to affect the overall determination.
core.String? rolePermissionRelevance;
GoogleCloudPolicysimulatorV1BindingExplanation({
this.access,
this.condition,
this.memberships,
this.relevance,
this.role,
this.rolePermission,
this.rolePermissionRelevance,
});
GoogleCloudPolicysimulatorV1BindingExplanation.fromJson(core.Map json_)
: this(
access: json_['access'] as core.String?,
condition: json_.containsKey('condition')
? GoogleTypeExpr.fromJson(
json_['condition'] as core.Map<core.String, core.dynamic>,
)
: null,
memberships:
(json_['memberships'] as core.Map<core.String, core.dynamic>?)?.map(
(key, value) => core.MapEntry(
key,
GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership.fromJson(
value as core.Map<core.String, core.dynamic>,
),
),
),
relevance: json_['relevance'] as core.String?,
role: json_['role'] as core.String?,
rolePermission: json_['rolePermission'] as core.String?,
rolePermissionRelevance:
json_['rolePermissionRelevance'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() {
final access = this.access;
final condition = this.condition;
final memberships = this.memberships;
final relevance = this.relevance;
final role = this.role;
final rolePermission = this.rolePermission;
final rolePermissionRelevance = this.rolePermissionRelevance;
return {
'access': ?access,
'condition': ?condition,
'memberships': ?memberships,
'relevance': ?relevance,
'role': ?role,
'rolePermission': ?rolePermission,
'rolePermissionRelevance': ?rolePermissionRelevance,
};
}
}
/// Details about whether the binding includes the principal.
class GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership {
/// Indicates whether the binding includes the principal.
/// Possible string values are:
/// - "MEMBERSHIP_UNSPECIFIED" : Default value. This value is unused.
/// - "MEMBERSHIP_INCLUDED" : The binding includes the principal. The
/// principal can be included directly or indirectly. For example: * A
/// principal is included directly if that principal is listed in the binding.
/// * A principal is included indirectly if that principal is in a Google
/// group or Google Workspace domain that is listed in the binding.
/// - "MEMBERSHIP_NOT_INCLUDED" : The binding does not include the principal.
/// - "MEMBERSHIP_UNKNOWN_INFO_DENIED" : The user who created the Replay is
/// not allowed to access the binding.
/// - "MEMBERSHIP_UNKNOWN_UNSUPPORTED" : The principal is an unsupported type.
/// Only Google Accounts and service accounts are supported.
core.String? membership;
/// The relevance of the principal's status to the overall determination for
/// the binding.
/// Possible string values are:
/// - "HEURISTIC_RELEVANCE_UNSPECIFIED" : Default value. This value is unused.
/// - "NORMAL" : The data point has a limited effect on the result. Changing
/// the data point is unlikely to affect the overall determination.
/// - "HIGH" : The data point has a strong effect on the result. Changing the
/// data point is likely to affect the overall determination.
core.String? relevance;
GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership({
this.membership,
this.relevance,
});
GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership.fromJson(
core.Map json_,
) : this(
membership: json_['membership'] as core.String?,
relevance: json_['relevance'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() {
final membership = this.membership;
final relevance = this.relevance;
return {'membership': ?membership, 'relevance': ?relevance};
}
}
/// Details about how a set of policies, listed in ExplainedPolicy, resulted in
/// a certain AccessState when replaying an access tuple.
class GoogleCloudPolicysimulatorV1ExplainedAccess {
/// Whether the principal in the access tuple has permission to access the
/// resource in the access tuple under the given policies.
/// Possible string values are:
/// - "ACCESS_STATE_UNSPECIFIED" : Default value. This value is unused.
/// - "GRANTED" : The principal has the permission.
/// - "NOT_GRANTED" : The principal does not have the permission.
/// - "UNKNOWN_CONDITIONAL" : The principal has the permission only if a
/// condition expression evaluates to `true`.
/// - "UNKNOWN_INFO_DENIED" : The user who created the Replay does not have
/// access to all of the policies that Policy Simulator needs to evaluate.
core.String? accessState;
/// If the AccessState is `UNKNOWN`, this field contains a list of errors
/// explaining why the result is `UNKNOWN`.
///
/// If the `AccessState` is `GRANTED` or `NOT_GRANTED`, this field is omitted.
core.List<GoogleRpcStatus>? errors;
/// If the AccessState is `UNKNOWN`, this field contains the policies that led
/// to that result.
///
/// If the `AccessState` is `GRANTED` or `NOT_GRANTED`, this field is omitted.
core.List<GoogleCloudPolicysimulatorV1ExplainedPolicy>? policies;
GoogleCloudPolicysimulatorV1ExplainedAccess({
this.accessState,
this.errors,
this.policies,
});
GoogleCloudPolicysimulatorV1ExplainedAccess.fromJson(core.Map json_)
: this(
accessState: json_['accessState'] as core.String?,
errors: (json_['errors'] as core.List?)
?.map(
(value) => GoogleRpcStatus.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
policies: (json_['policies'] as core.List?)
?.map(
(value) => GoogleCloudPolicysimulatorV1ExplainedPolicy.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() {
final accessState = this.accessState;
final errors = this.errors;
final policies = this.policies;
return {
'accessState': ?accessState,
'errors': ?errors,
'policies': ?policies,
};
}
}
/// Details about how a specific IAM Policy contributed to the access check.
class GoogleCloudPolicysimulatorV1ExplainedPolicy {
/// Indicates whether _this policy_ provides the specified permission to the
/// specified principal for the specified resource.
///
/// This field does _not_ indicate whether the principal actually has the
/// permission for the resource. There might be another policy that overrides
/// this policy. To determine whether the principal actually has the
/// permission, use the `access` field in the TroubleshootIamPolicyResponse.
/// Possible string values are:
/// - "ACCESS_STATE_UNSPECIFIED" : Default value. This value is unused.
/// - "GRANTED" : The principal has the permission.
/// - "NOT_GRANTED" : The principal does not have the permission.
/// - "UNKNOWN_CONDITIONAL" : The principal has the permission only if a
/// condition expression evaluates to `true`.
/// - "UNKNOWN_INFO_DENIED" : The user who created the Replay does not have
/// access to all of the policies that Policy Simulator needs to evaluate.
core.String? access;
/// Details about how each binding in the policy affects the principal's
/// ability, or inability, to use the permission for the resource.
///
/// If the user who created the Replay does not have access to the policy,
/// this field is omitted.
core.List<GoogleCloudPolicysimulatorV1BindingExplanation>?
bindingExplanations;
/// The full resource name that identifies the resource.
///
/// For example,
/// `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`.
/// If the user who created the Replay does not have access to the policy,
/// this field is omitted. For examples of full resource names for Google
/// Cloud services, see
/// https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
core.String? fullResourceName;
/// The IAM policy attached to the resource.
///
/// If the user who created the Replay does not have access to the policy,
/// this field is empty.
GoogleIamV1Policy? policy;
/// The relevance of this policy to the overall determination in the
/// TroubleshootIamPolicyResponse.
///
/// If the user who created the Replay does not have access to the policy,
/// this field is omitted.
/// Possible string values are:
/// - "HEURISTIC_RELEVANCE_UNSPECIFIED" : Default value. This value is unused.
/// - "NORMAL" : The data point has a limited effect on the result. Changing
/// the data point is unlikely to affect the overall determination.
/// - "HIGH" : The data point has a strong effect on the result. Changing the
/// data point is likely to affect the overall determination.
core.String? relevance;
GoogleCloudPolicysimulatorV1ExplainedPolicy({
this.access,
this.bindingExplanations,
this.fullResourceName,
this.policy,
this.relevance,
});
GoogleCloudPolicysimulatorV1ExplainedPolicy.fromJson(core.Map json_)
: this(
access: json_['access'] as core.String?,
bindingExplanations: (json_['bindingExplanations'] as core.List?)
?.map(
(value) =>
GoogleCloudPolicysimulatorV1BindingExplanation.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
fullResourceName: json_['fullResourceName'] as core.String?,
policy: json_.containsKey('policy')
? GoogleIamV1Policy.fromJson(
json_['policy'] as core.Map<core.String, core.dynamic>,
)
: null,
relevance: json_['relevance'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() {
final access = this.access;
final bindingExplanations = this.bindingExplanations;
final fullResourceName = this.fullResourceName;
final policy = this.policy;
final relevance = this.relevance;
return {
'access': ?access,
'bindingExplanations': ?bindingExplanations,
'fullResourceName': ?fullResourceName,
'policy': ?policy,
'relevance': ?relevance,
};
}
}
/// ListOrgPolicyViolationsPreviewsResponse is the response message for
/// OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews.
class GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse {
/// A token that you can use to retrieve the next page of results.
///
/// If this field is omitted, there are no subsequent pages.
core.String? nextPageToken;
/// The list of OrgPolicyViolationsPreview
core.List<GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview>?
orgPolicyViolationsPreviews;
GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse({
this.nextPageToken,
this.orgPolicyViolationsPreviews,
});
GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse.fromJson(
core.Map json_,
) : this(
nextPageToken: json_['nextPageToken'] as core.String?,
orgPolicyViolationsPreviews:
(json_['orgPolicyViolationsPreviews'] as core.List?)
?.map(
(value) =>
GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() {
final nextPageToken = this.nextPageToken;
final orgPolicyViolationsPreviews = this.orgPolicyViolationsPreviews;
return {
'nextPageToken': ?nextPageToken,
'orgPolicyViolationsPreviews': ?orgPolicyViolationsPreviews,
};
}
}
/// ListOrgPolicyViolationsResponse is the response message for
/// OrgPolicyViolationsPreviewService.ListOrgPolicyViolations
class GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse {
/// A token that you can use to retrieve the next page of results.
///
/// If this field is omitted, there are no subsequent pages.
core.String? nextPageToken;
/// The list of OrgPolicyViolations
core.List<GoogleCloudPolicysimulatorV1OrgPolicyViolation>?
orgPolicyViolations;
GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse({
this.nextPageToken,
this.orgPolicyViolations,
});
GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse.fromJson(
core.Map json_,
) : this(
nextPageToken: json_['nextPageToken'] as core.String?,
orgPolicyViolations: (json_['orgPolicyViolations'] as core.List?)
?.map(
(value) =>
GoogleCloudPolicysimulatorV1OrgPolicyViolation.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() {
final nextPageToken = this.nextPageToken;
final orgPolicyViolations = this.orgPolicyViolations;
return {
'nextPageToken': ?nextPageToken,
'orgPolicyViolations': ?orgPolicyViolations,
};
}
}
/// Response message for Simulator.ListReplayResults.
class GoogleCloudPolicysimulatorV1ListReplayResultsResponse {
/// A token that you can use to retrieve the next page of ReplayResult
/// objects.
///
/// If this field is omitted, there are no subsequent pages.
core.String? nextPageToken;
/// The results of running a Replay.
core.List<GoogleCloudPolicysimulatorV1ReplayResult>? replayResults;
GoogleCloudPolicysimulatorV1ListReplayResultsResponse({
this.nextPageToken,
this.replayResults,
});
GoogleCloudPolicysimulatorV1ListReplayResultsResponse.fromJson(core.Map json_)
: this(
nextPageToken: json_['nextPageToken'] as core.String?,
replayResults: (json_['replayResults'] as core.List?)
?.map(
(value) => GoogleCloudPolicysimulatorV1ReplayResult.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() {
final nextPageToken = this.nextPageToken;
final replayResults = this.replayResults;
return {'nextPageToken': ?nextPageToken, 'replayResults': ?replayResults};
}
}
/// The proposed changes to OrgPolicy.
class GoogleCloudPolicysimulatorV1OrgPolicyOverlay {
/// The OrgPolicy CustomConstraint changes to preview violations for.
///
/// Any existing CustomConstraints with the same name will be overridden in
/// the simulation. That is, violations will be determined as if all custom
/// constraints in the overlay were instantiated. Only a single
/// custom_constraint is supported in the overlay at a time. For evaluating
/// multiple constraints, multiple `GenerateOrgPolicyViolationsPreview`
/// requests are made, where each request evaluates a single constraint.
///
/// Optional.
core.List<
GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay
>?
customConstraints;
/// The OrgPolicy changes to preview violations for.
///
/// Any existing OrgPolicies with the same name will be overridden in the
/// simulation. That is, violations will be determined as if all policies in
/// the overlay were created or updated.
///
/// Optional.
core.List<GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay>?
policies;
GoogleCloudPolicysimulatorV1OrgPolicyOverlay({
this.customConstraints,
this.policies,
});
GoogleCloudPolicysimulatorV1OrgPolicyOverlay.fromJson(core.Map json_)
: this(
customConstraints: (json_['customConstraints'] as core.List?)
?.map(
(value) =>
GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
policies: (json_['policies'] as core.List?)
?.map(
(value) =>
GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() {
final customConstraints = this.customConstraints;
final policies = this.policies;
return {'customConstraints': ?customConstraints, 'policies': ?policies};
}
}
/// A change to an OrgPolicy custom constraint.
class GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay {
/// The new or updated custom constraint.
///
/// Optional.
GoogleCloudOrgpolicyV2CustomConstraint? customConstraint;
/// Resource the constraint is attached to.
///
/// Example: "organization/987654"
///
/// Optional.
core.String? customConstraintParent;
GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay({
this.customConstraint,
this.customConstraintParent,
});
GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay.fromJson(
core.Map json_,
) : this(
customConstraint: json_.containsKey('customConstraint')
? GoogleCloudOrgpolicyV2CustomConstraint.fromJson(
json_['customConstraint']
as core.Map<core.String, core.dynamic>,
)
: null,
customConstraintParent: json_['customConstraintParent'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() {
final customConstraint = this.customConstraint;
final customConstraintParent = this.customConstraintParent;
return {
'customConstraint': ?customConstraint,
'customConstraintParent': ?customConstraintParent,
};
}
}
/// A change to an OrgPolicy.
class GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay {
/// The new or updated OrgPolicy.
///
/// Optional.
GoogleCloudOrgpolicyV2Policy? policy;
/// The parent of the policy we are attaching to.
///
/// Example: "projects/123456"
///
/// Optional.
core.String? policyParent;
GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay({
this.policy,
this.policyParent,
});
GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay.fromJson(
core.Map json_,
) : this(
policy: json_.containsKey('policy')
? GoogleCloudOrgpolicyV2Policy.fromJson(
json_['policy'] as core.Map<core.String, core.dynamic>,
)
: null,
policyParent: json_['policyParent'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() {
final policy = this.policy;
final policyParent = this.policyParent;
return {'policy': ?policy, 'policyParent': ?policyParent};
}
}
/// OrgPolicyViolation is a resource representing a single resource violating a
/// single OrgPolicy constraint.
class GoogleCloudPolicysimulatorV1OrgPolicyViolation {
/// The custom constraint being violated.
GoogleCloudOrgpolicyV2CustomConstraint? customConstraint;
/// Any error encountered during the evaluation.
GoogleRpcStatus? error;
/// The name of the \`OrgPolicyViolation\`.
///
/// Example:
/// organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f/orgPolicyViolations/38ce\`
core.String? name;
/// The resource violating the constraint.
GoogleCloudPolicysimulatorV1ResourceContext? resource;
GoogleCloudPolicysimulatorV1OrgPolicyViolation({
this.customConstraint,
this.error,
this.name,
this.resource,
});
GoogleCloudPolicysimulatorV1OrgPolicyViolation.fromJson(core.Map json_)
: this(
customConstraint: json_.containsKey('customConstraint')
? GoogleCloudOrgpolicyV2CustomConstraint.fromJson(
json_['customConstraint']
as core.Map<core.String, core.dynamic>,
)
: null,
error: json_.containsKey('error')
? GoogleRpcStatus.fromJson(
json_['error'] as core.Map<core.String, core.dynamic>,
)
: null,
name: json_['name'] as core.String?,
resource: json_.containsKey('resource')
? GoogleCloudPolicysimulatorV1ResourceContext.fromJson(
json_['resource'] as core.Map<core.String, core.dynamic>,
)
: null,
);
core.Map<core.String, core.dynamic> toJson() {
final customConstraint = this.customConstraint;
final error = this.error;
final name = this.name;
final resource = this.resource;
return {
'customConstraint': ?customConstraint,
'error': ?error,
'name': ?name,
'resource': ?resource,
};
}
}
/// OrgPolicyViolationsPreview is a resource providing a preview of the
/// violations that will exist if an OrgPolicy change is made.
///
/// The list of violations are modeled as child resources and retrieved via a
/// ListOrgPolicyViolations API call. There are potentially more
/// OrgPolicyViolations than could fit in an embedded field. Thus, the use of a
/// child resource instead of a field.
class GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview {
/// Time when this `OrgPolicyViolationsPreview` was created.
///
/// Output only.
core.String? createTime;
/// The names of the constraints against which all `OrgPolicyViolations` were
/// evaluated.
///
/// If `OrgPolicyOverlay` only contains `PolicyOverlay` then it contains the
/// name of the configured custom constraint, applicable to the specified
/// policies. Otherwise it contains the name of the constraint specified in
/// `CustomConstraintOverlay`. Format:
/// `organizations/{organization_id}/customConstraints/{custom_constraint_id}`
/// Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`
///
/// Output only.
core.List<core.String>? customConstraints;
/// The resource name of the `OrgPolicyViolationsPreview`.
///
/// It has the following format:
/// `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}`
/// Example:
/// `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f`
///
/// Output only.
core.String? name;
/// The proposed changes we are previewing violations for.
///
/// Required.
GoogleCloudPolicysimulatorV1OrgPolicyOverlay? overlay;
/// A summary of the state of all resources scanned for compliance with the
/// changed OrgPolicy.
///
/// Output only.
GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts?
resourceCounts;
/// The state of the `OrgPolicyViolationsPreview`.
///
/// Output only.
/// Possible string values are:
/// - "PREVIEW_STATE_UNSPECIFIED" : The state is unspecified.
/// - "PREVIEW_PENDING" : The OrgPolicyViolationsPreview has not been created
/// yet.
/// - "PREVIEW_RUNNING" : The OrgPolicyViolationsPreview is currently being
/// created.
/// - "PREVIEW_SUCCEEDED" : The OrgPolicyViolationsPreview creation finished
/// successfully.
/// - "PREVIEW_FAILED" : The OrgPolicyViolationsPreview creation failed with
/// an error.
core.String? state;
/// The number of OrgPolicyViolations in this `OrgPolicyViolationsPreview`.
///
/// This count may differ from `resource_summary.noncompliant_count` because
/// each OrgPolicyViolation is specific to a resource **and** constraint. If
/// there are multiple constraints being evaluated (i.e. multiple policies in
/// the overlay), a single resource may violate multiple constraints.
///
/// Output only.
core.int? violationsCount;
GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview({
this.createTime,
this.customConstraints,
this.name,
this.overlay,
this.resourceCounts,
this.state,
this.violationsCount,
});
GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview.fromJson(
core.Map json_,
) : this(
createTime: json_['createTime'] as core.String?,
customConstraints: (json_['customConstraints'] as core.List?)
?.map((value) => value as core.String)
.toList(),
name: json_['name'] as core.String?,
overlay: json_.containsKey('overlay')
? GoogleCloudPolicysimulatorV1OrgPolicyOverlay.fromJson(
json_['overlay'] as core.Map<core.String, core.dynamic>,
)
: null,
resourceCounts: json_.containsKey('resourceCounts')
? GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts.fromJson(
json_['resourceCounts'] as core.Map<core.String, core.dynamic>,
)
: null,
state: json_['state'] as core.String?,
violationsCount: json_['violationsCount'] as core.int?,
);
core.Map<core.String, core.dynamic> toJson() {
final createTime = this.createTime;
final customConstraints = this.customConstraints;
final name = this.name;
final overlay = this.overlay;
final resourceCounts = this.resourceCounts;
final state = this.state;
final violationsCount = this.violationsCount;
return {
'createTime': ?createTime,
'customConstraints': ?customConstraints,
'name': ?name,
'overlay': ?overlay,
'resourceCounts': ?resourceCounts,
'state': ?state,
'violationsCount': ?violationsCount,
};
}
}
/// A summary of the state of all resources scanned for compliance with the
/// changed OrgPolicy.
class GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts {
/// Number of scanned resources with zero violations.
///
/// Output only.
core.int? compliant;
/// Number of resources that returned an error when scanned.
///
/// Output only.
core.int? errors;
/// Number of scanned resources with at least one violation.
///
/// Output only.
core.int? noncompliant;
/// Number of resources checked for compliance.
///
/// Must equal: unenforced + noncompliant + compliant + error
///
/// Output only.
core.int? scanned;
/// Number of resources where the constraint was not enforced, i.e. the Policy
/// set `enforced: false` for that resource.
///
/// Output only.
core.int? unenforced;
GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts({
this.compliant,
this.errors,
this.noncompliant,
this.scanned,
this.unenforced,
});
GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts.fromJson(
core.Map json_,
) : this(
compliant: json_['compliant'] as core.int?,
errors: json_['errors'] as core.int?,
noncompliant: json_['noncompliant'] as core.int?,
scanned: json_['scanned'] as core.int?,
unenforced: json_['unenforced'] as core.int?,
);
core.Map<core.String, core.dynamic> toJson() {
final compliant = this.compliant;
final errors = this.errors;
final noncompliant = this.noncompliant;
final scanned = this.scanned;
final unenforced = this.unenforced;
return {
'compliant': ?compliant,
'errors': ?errors,
'noncompliant': ?noncompliant,
'scanned': ?scanned,
'unenforced': ?unenforced,
};
}
}
/// A resource describing a `Replay`, or simulation.
class GoogleCloudPolicysimulatorV1Replay {
/// The configuration used for the `Replay`.
///
/// Required.
GoogleCloudPolicysimulatorV1ReplayConfig? config;
/// The resource name of the `Replay`, which has the following format:
/// `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`,
/// where `{resource-id}` is the ID of the project, folder, or organization
/// that owns the Replay.
///
/// Example:
/// `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
///
/// Output only.
core.String? name;
/// Summary statistics about the replayed log entries.
///
/// Output only.
GoogleCloudPolicysimulatorV1ReplayResultsSummary? resultsSummary;
/// The current state of the `Replay`.
///
/// Output only.
/// Possible string values are:
/// - "STATE_UNSPECIFIED" : Default value. This value is unused.
/// - "PENDING" : The `Replay` has not started yet.
/// - "RUNNING" : The `Replay` is currently running.
/// - "SUCCEEDED" : The `Replay` has successfully completed.
/// - "FAILED" : The `Replay` has finished with an error.
core.String? state;
GoogleCloudPolicysimulatorV1Replay({
this.config,
this.name,
this.resultsSummary,
this.state,
});
GoogleCloudPolicysimulatorV1Replay.fromJson(core.Map json_)
: this(
config: json_.containsKey('config')
? GoogleCloudPolicysimulatorV1ReplayConfig.fromJson(
json_['config'] as core.Map<core.String, core.dynamic>,
)
: null,
name: json_['name'] as core.String?,
resultsSummary: json_.containsKey('resultsSummary')
? GoogleCloudPolicysimulatorV1ReplayResultsSummary.fromJson(
json_['resultsSummary'] as core.Map<core.String, core.dynamic>,
)
: null,
state: json_['state'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() {
final config = this.config;
final name = this.name;
final resultsSummary = this.resultsSummary;
final state = this.state;
return {
'config': ?config,
'name': ?name,
'resultsSummary': ?resultsSummary,
'state': ?state,
};
}
}
/// The configuration used for a Replay.
class GoogleCloudPolicysimulatorV1ReplayConfig {
/// The logs to use as input for the Replay.
/// Possible string values are:
/// - "LOG_SOURCE_UNSPECIFIED" : An unspecified log source. If the log source
/// is unspecified, the Replay defaults to using `RECENT_ACCESSES`.
/// - "RECENT_ACCESSES" : All access logs from the last 90 days. These logs
/// may not include logs from the most recent 7 days.
core.String? logSource;
/// A mapping of the resources that you want to simulate policies for and the
/// policies that you want to simulate.
///
/// Keys are the full resource names for the resources. For example,
/// `//cloudresourcemanager.googleapis.com/projects/my-project`. For examples
/// of full resource names for Google Cloud services, see
/// https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
/// Values are Policy objects representing the policies that you want to
/// simulate. Replays automatically take into account any IAM policies
/// inherited through the resource hierarchy, and any policies set on
/// descendant resources. You do not need to include these policies in the
/// policy overlay.
core.Map<core.String, GoogleIamV1Policy>? policyOverlay;
GoogleCloudPolicysimulatorV1ReplayConfig({
this.logSource,
this.policyOverlay,
});
GoogleCloudPolicysimulatorV1ReplayConfig.fromJson(core.Map json_)
: this(
logSource: json_['logSource'] as core.String?,
policyOverlay:
(json_['policyOverlay'] as core.Map<core.String, core.dynamic>?)
?.map(
(key, value) => core.MapEntry(
key,
GoogleIamV1Policy.fromJson(
value as core.Map<core.String, core.dynamic>,
),
),
),
);
core.Map<core.String, core.dynamic> toJson() {
final logSource = this.logSource;
final policyOverlay = this.policyOverlay;
return {'logSource': ?logSource, 'policyOverlay': ?policyOverlay};
}
}
/// The difference between the results of evaluating an access tuple under the
/// current (baseline) policies and under the proposed (simulated) policies.
///
/// This difference explains how a principal's access could change if the
/// proposed policies were applied.
class GoogleCloudPolicysimulatorV1ReplayDiff {
/// A summary and comparison of the principal's access under the current
/// (baseline) policies and the proposed (simulated) policies for a single
/// access tuple.
///
/// The evaluation of the principal's access is reported in the AccessState
/// field.
GoogleCloudPolicysimulatorV1AccessStateDiff? accessDiff;
GoogleCloudPolicysimulatorV1ReplayDiff({this.accessDiff});
GoogleCloudPolicysimulatorV1ReplayDiff.fromJson(core.Map json_)
: this(
accessDiff: json_.containsKey('accessDiff')
? GoogleCloudPolicysimulatorV1AccessStateDiff.fromJson(
json_['accessDiff'] as core.Map<core.String, core.dynamic>,
)
: null,
);
core.Map<core.String, core.dynamic> toJson() {
final accessDiff = this.accessDiff;
return {'accessDiff': ?accessDiff};
}
}
/// The result of replaying a single access tuple against a simulated state.
class GoogleCloudPolicysimulatorV1ReplayResult {
/// The access tuple that was replayed.
///
/// This field includes information about the principal, resource, and
/// permission that were involved in the access attempt.
GoogleCloudPolicysimulatorV1AccessTuple? accessTuple;
/// The difference between the principal's access under the current (baseline)
/// policies and the principal's access under the proposed (simulated)
/// policies.
///
/// This field is only included for access tuples that were successfully
/// replayed and had different results under the current policies and the
/// proposed policies.
GoogleCloudPolicysimulatorV1ReplayDiff? diff;
/// The error that caused the access tuple replay to fail.
///
/// This field is only included for access tuples that were not replayed
/// successfully.
GoogleRpcStatus? error;
/// The latest date this access tuple was seen in the logs.
GoogleTypeDate? lastSeenDate;
/// The resource name of the `ReplayResult`, in the following format:
/// `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}/results/{replay-result-id}`,
/// where `{resource-id}` is the ID of the project, folder, or organization
/// that owns the Replay.
///
/// Example:
/// `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36/results/1234`
core.String? name;
/// The Replay that the access tuple was included in.
core.String? parent;
GoogleCloudPolicysimulatorV1ReplayResult({
this.accessTuple,
this.diff,
this.error,
this.lastSeenDate,
this.name,
this.parent,
});
GoogleCloudPolicysimulatorV1ReplayResult.fromJson(core.Map json_)
: this(
accessTuple: json_.containsKey('accessTuple')
? GoogleCloudPolicysimulatorV1AccessTuple.fromJson(
json_['accessTuple'] as core.Map<core.String, core.dynamic>,
)
: null,
diff: json_.containsKey('diff')
? GoogleCloudPolicysimulatorV1ReplayDiff.fromJson(
json_['diff'] as core.Map<core.String, core.dynamic>,
)
: null,
error: json_.containsKey('error')
? GoogleRpcStatus.fromJson(
json_['error'] as core.Map<core.String, core.dynamic>,
)
: null,
lastSeenDate: json_.containsKey('lastSeenDate')
? GoogleTypeDate.fromJson(
json_['lastSeenDate'] as core.Map<core.String, core.dynamic>,
)
: null,
name: json_['name'] as core.String?,
parent: json_['parent'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() {
final accessTuple = this.accessTuple;
final diff = this.diff;
final error = this.error;
final lastSeenDate = this.lastSeenDate;
final name = this.name;
final parent = this.parent;
return {
'accessTuple': ?accessTuple,
'diff': ?diff,
'error': ?error,
'lastSeenDate': ?lastSeenDate,
'name': ?name,
'parent': ?parent,
};
}
}
/// Summary statistics about the replayed log entries.
class GoogleCloudPolicysimulatorV1ReplayResultsSummary {
/// The number of replayed log entries with a difference between baseline and
/// simulated policies.
core.int? differenceCount;
/// The number of log entries that could not be replayed.
core.int? errorCount;
/// The total number of log entries replayed.
core.int? logCount;
/// The date of the newest log entry replayed.
GoogleTypeDate? newestDate;
/// The date of the oldest log entry replayed.
GoogleTypeDate? oldestDate;
/// The number of replayed log entries with no difference between baseline and
/// simulated policies.
core.int? unchangedCount;
GoogleCloudPolicysimulatorV1ReplayResultsSummary({
this.differenceCount,
this.errorCount,
this.logCount,
this.newestDate,
this.oldestDate,
this.unchangedCount,
});
GoogleCloudPolicysimulatorV1ReplayResultsSummary.fromJson(core.Map json_)
: this(
differenceCount: json_['differenceCount'] as core.int?,
errorCount: json_['errorCount'] as core.int?,
logCount: json_['logCount'] as core.int?,
newestDate: json_.containsKey('newestDate')
? GoogleTypeDate.fromJson(
json_['newestDate'] as core.Map<core.String, core.dynamic>,
)
: null,
oldestDate: json_.containsKey('oldestDate')
? GoogleTypeDate.fromJson(
json_['oldestDate'] as core.Map<core.String, core.dynamic>,
)
: null,
unchangedCount: json_['unchangedCount'] as core.int?,
);
core.Map<core.String, core.dynamic> toJson() {
final differenceCount = this.differenceCount;
final errorCount = this.errorCount;
final logCount = this.logCount;
final newestDate = this.newestDate;
final oldestDate = this.oldestDate;
final unchangedCount = this.unchangedCount;
return {
'differenceCount': ?differenceCount,
'errorCount': ?errorCount,
'logCount': ?logCount,
'newestDate': ?newestDate,
'oldestDate': ?oldestDate,
'unchangedCount': ?unchangedCount,
};
}
}
/// ResourceContext provides the context we know about a resource.
///
/// It is similar in concept to google.cloud.asset.v1.Resource, but focuses on
/// the information specifically used by Simulator.
class GoogleCloudPolicysimulatorV1ResourceContext {
/// The ancestry path of the resource in Google Cloud
/// [resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy),
/// represented as a list of relative resource names.
///
/// An ancestry path starts with the closest ancestor in the hierarchy and
/// ends at root. If the resource is a project, folder, or organization, the
/// ancestry path starts from the resource itself. Example:
/// `["projects/123456789", "folders/5432", "organizations/1234"]`
core.List<core.String>? ancestors;
/// The asset type of the resource as defined by CAIS.
///
/// Example: `compute.googleapis.com/Firewall` See
/// [Supported asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
/// for more information.
core.String? assetType;
/// The full name of the resource.
///
/// Example:
/// `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`
/// See
/// [Resource names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
/// for more information.
core.String? resource;
GoogleCloudPolicysimulatorV1ResourceContext({
this.ancestors,
this.assetType,
this.resource,
});
GoogleCloudPolicysimulatorV1ResourceContext.fromJson(core.Map json_)
: this(
ancestors: (json_['ancestors'] as core.List?)
?.map((value) => value as core.String)
.toList(),
assetType: json_['assetType'] as core.String?,
resource: json_['resource'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() {
final ancestors = this.ancestors;
final assetType = this.assetType;
final resource = this.resource;
return {
'ancestors': ?ancestors,
'assetType': ?assetType,
'resource': ?resource,
};
}
}
/// Specifies the audit configuration for a service.
///
/// The configuration determines which permission types are logged, and what
/// identities, if any, are exempted from logging. An AuditConfig must have one
/// or more AuditLogConfigs. If there are AuditConfigs for both `allServices`
/// and a specific service, the union of the two AuditConfigs is used for that
/// service: the log_types specified in each AuditConfig are enabled, and the
/// exempted_members in each AuditLogConfig are exempted. Example Policy with
/// multiple AuditConfigs: { "audit_configs": \[ { "service": "allServices",
/// "audit_log_configs": \[ { "log_type": "DATA_READ", "exempted_members": \[
/// "user:jose@example.com" \] }, { "log_type": "DATA_WRITE" }, { "log_type":
/// "ADMIN_READ" } \] }, { "service": "sampleservice.googleapis.com",
/// "audit_log_configs": \[ { "log_type": "DATA_READ" }, { "log_type":
/// "DATA_WRITE", "exempted_members": \[ "user:aliya@example.com" \] } \] } \] }
/// For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
/// logging. It also exempts `jose@example.com` from DATA_READ logging, and
/// `aliya@example.com` from DATA_WRITE logging.
class GoogleIamV1AuditConfig {
/// The configuration for logging of each type of permission.
core.List<GoogleIamV1AuditLogConfig>? auditLogConfigs;
/// Specifies a service that will be enabled for audit logging.
///
/// For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
/// `allServices` is a special value that covers all services.
core.String? service;
GoogleIamV1AuditConfig({this.auditLogConfigs, this.service});
GoogleIamV1AuditConfig.fromJson(core.Map json_)
: this(
auditLogConfigs: (json_['auditLogConfigs'] as core.List?)
?.map(
(value) => GoogleIamV1AuditLogConfig.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
service: json_['service'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() {
final auditLogConfigs = this.auditLogConfigs;
final service = this.service;
return {'auditLogConfigs': ?auditLogConfigs, 'service': ?service};
}
}
/// Provides the configuration for logging a type of permissions.
///
/// Example: { "audit_log_configs": \[ { "log_type": "DATA_READ",
/// "exempted_members": \[ "user:jose@example.com" \] }, { "log_type":
/// "DATA_WRITE" } \] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while
/// exempting jose@example.com from DATA_READ logging.
typedef GoogleIamV1AuditLogConfig = $AuditLogConfig;
/// Associates `members`, or principals, with a `role`.
class GoogleIamV1Binding {
/// The condition that is associated with this binding.
///
/// If the condition evaluates to `true`, then this binding applies to the
/// current request. If the condition evaluates to `false`, then this binding
/// does not apply to the current request. However, a different role binding
/// might grant the same role to one or more of the principals in this
/// binding. To learn which resources support conditions in their IAM
/// policies, see the
/// [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
GoogleTypeExpr? condition;
/// Specifies the principals requesting access for a Google Cloud resource.
///
/// `members` can have the following values: * `allUsers`: A special
/// identifier that represents anyone who is on the internet; with or without
/// a Google account. * `allAuthenticatedUsers`: A special identifier that
/// represents anyone who is authenticated with a Google account or a service
/// account. Does not include identities that come from external identity
/// providers (IdPs) through identity federation. * `user:{emailid}`: An email
/// address that represents a specific Google account. For example,
/// `alice@example.com` . * `serviceAccount:{emailid}`: An email address that
/// represents a Google service account. For example,
/// `my-other-app@appspot.gserviceaccount.com`. *
/// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
/// identifier for a
/// [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
/// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
/// `group:{emailid}`: An email address that represents a Google group. For
/// example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
/// (primary) that represents all the users of that domain. For example,
/// `google.com` or `example.com`. *
/// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
/// A single identity in a workforce identity pool. *
/// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
/// All workforce identities in a group. *
/// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
/// All workforce identities with a specific attribute value. *
/// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}
/// / * `: All identities in a workforce identity pool. *
/// `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
/// A single identity in a workload identity pool. *
/// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
/// A workload identity pool group. *
/// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
/// All identities in a workload identity pool with a certain attribute. *
/// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}
/// / * `: All identities in a workload identity pool. *
/// `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
/// identifier) representing a user that has been recently deleted. For
/// example, `alice@example.com?uid=123456789012345678901`. If the user is
/// recovered, this value reverts to `user:{emailid}` and the recovered user
/// retains the role in the binding. *
/// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
/// unique identifier) representing a service account that has been recently
/// deleted. For example,
/// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If
/// the service account is undeleted, this value reverts to
/// `serviceAccount:{emailid}` and the undeleted service account retains the
/// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email
/// address (plus unique identifier) representing a Google group that has been
/// recently deleted. For example,
/// `admins@example.com?uid=123456789012345678901`. If the group is recovered,
/// this value reverts to `group:{emailid}` and the recovered group retains
/// the role in the binding. *
/// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
/// Deleted single identity in a workforce identity pool. For example,
/// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
core.List<core.String>? members;
/// Role that is assigned to the list of `members`, or principals.
///
/// For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an
/// overview of the IAM roles and permissions, see the
/// [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
/// a list of the available pre-defined roles, see
/// [here](https://cloud.google.com/iam/docs/understanding-roles).
core.String? role;
GoogleIamV1Binding({this.condition, this.members, this.role});
GoogleIamV1Binding.fromJson(core.Map json_)
: this(
condition: json_.containsKey('condition')
? GoogleTypeExpr.fromJson(
json_['condition'] as core.Map<core.String, core.dynamic>,
)
: null,
members: (json_['members'] as core.List?)
?.map((value) => value as core.String)
.toList(),
role: json_['role'] as core.String?,
);
core.Map<core.String, core.dynamic> toJson() {
final condition = this.condition;
final members = this.members;
final role = this.role;
return {'condition': ?condition, 'members': ?members, 'role': ?role};
}
}
/// An Identity and Access Management (IAM) policy, which specifies access
/// controls for Google Cloud resources.
///
/// A `Policy` is a collection of `bindings`. A `binding` binds one or more
/// `members`, or principals, to a single `role`. Principals can be user
/// accounts, service accounts, Google groups, and domains (such as G Suite). A
/// `role` is a named list of permissions; each `role` can be an IAM predefined
/// role or a user-created custom role. For some types of Google Cloud
/// resources, a `binding` can also specify a `condition`, which is a logical
/// expression that allows access to a resource only if the expression evaluates
/// to `true`. A condition can add constraints based on attributes of the
/// request, the resource, or both. To learn which resources support conditions
/// in their IAM policies, see the
/// [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
/// **JSON example:** ``` { "bindings": [ { "role":
/// "roles/resourcemanager.organizationAdmin", "members": [
/// "user:mike@example.com", "group:admins@example.com", "domain:google.com",
/// "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role":
/// "roles/resourcemanager.organizationViewer", "members": [
/// "user:eve@example.com" ], "condition": { "title": "expirable access",
/// "description": "Does not grant access after Sep 2020", "expression":
/// "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag":
/// "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: -
/// members: - user:mike@example.com - group:admins@example.com -
/// domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com
/// role: roles/resourcemanager.organizationAdmin - members: -
/// user:eve@example.com role: roles/resourcemanager.organizationViewer
/// condition: title: expirable access description: Does not grant access after
/// Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
/// etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features,
/// see the [IAM documentation](https://cloud.google.com/iam/docs/).
class GoogleIamV1Policy {
/// Specifies cloud audit logging configuration for this policy.
core.List<GoogleIamV1AuditConfig>? auditConfigs;
/// Associates a list of `members`, or principals, with a `role`.
///
/// Optionally, may specify a `condition` that determines how and when the
/// `bindings` are applied. Each of the `bindings` must contain at least one
/// principal. The `bindings` in a `Policy` can refer to up to 1,500
/// principals; up to 250 of these principals can be Google groups. Each
/// occurrence of a principal counts towards these limits. For example, if the
/// `bindings` grant 50 different roles to `user:alice@example.com`, and not
/// to any other principal, then you can add another 1,450 principals to the
/// `bindings` in the `Policy`.
core.List<GoogleIamV1Binding>? bindings;
/// `etag` is used for optimistic concurrency control as a way to help prevent
/// simultaneous updates of a policy from overwriting each other.
///
/// It is strongly suggested that systems make use of the `etag` in the
/// read-modify-write cycle to perform policy updates in order to avoid race
/// conditions: An `etag` is returned in the response to `getIamPolicy`, and
/// systems are expected to put that etag in the request to `setIamPolicy` to
/// ensure that their change will be applied to the same version of the
/// policy. **Important:** If you use IAM Conditions, you must include the
/// `etag` field whenever you call `setIamPolicy`. If you omit this field,
/// then IAM allows you to overwrite a version `3` policy with a version `1`
/// policy, and all of the conditions in the version `3` policy are lost.
core.String? etag;
core.List<core.int> get etagAsBytes => convert.base64.decode(etag!);
set etagAsBytes(core.List<core.int> bytes_) {
etag = convert.base64
.encode(bytes_)
.replaceAll('/', '_')
.replaceAll('+', '-');
}
/// Specifies the format of the policy.
///
/// Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
/// are rejected. Any operation that affects conditional role bindings must
/// specify version `3`. This requirement applies to the following operations:
/// * Getting a policy that includes a conditional role binding * Adding a
/// conditional role binding to a policy * Changing a conditional role binding
/// in a policy * Removing any role binding, with or without a condition, from
/// a policy that includes conditions **Important:** If you use IAM
/// Conditions, you must include the `etag` field whenever you call
/// `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a
/// version `3` policy with a version `1` policy, and all of the conditions in
/// the version `3` policy are lost. If a policy does not include any
/// conditions, operations on that policy may specify any valid version or
/// leave the field unset. To learn which resources support conditions in
/// their IAM policies, see the
/// [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
core.int? version;
GoogleIamV1Policy({
this.auditConfigs,
this.bindings,
this.etag,
this.version,
});
GoogleIamV1Policy.fromJson(core.Map json_)
: this(
auditConfigs: (json_['auditConfigs'] as core.List?)
?.map(
(value) => GoogleIamV1AuditConfig.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
bindings: (json_['bindings'] as core.List?)
?.map(
(value) => GoogleIamV1Binding.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
etag: json_['etag'] as core.String?,
version: json_['version'] as core.int?,
);
core.Map<core.String, core.dynamic> toJson() {
final auditConfigs = this.auditConfigs;
final bindings = this.bindings;
final etag = this.etag;
final version = this.version;
return {
'auditConfigs': ?auditConfigs,
'bindings': ?bindings,
'etag': ?etag,
'version': ?version,
};
}
}
/// The response message for Operations.ListOperations.
class GoogleLongrunningListOperationsResponse {
/// The standard List next-page token.
core.String? nextPageToken;
/// A list of operations that matches the specified filter in the request.
core.List<GoogleLongrunningOperation>? operations;
/// Unordered list.
///
/// Unreachable resources. Populated when the request sets
/// `ListOperationsRequest.return_partial_success` and reads across
/// collections. For example, when attempting to list all resources across all
/// supported locations.
core.List<core.String>? unreachable;
GoogleLongrunningListOperationsResponse({
this.nextPageToken,
this.operations,
this.unreachable,
});
GoogleLongrunningListOperationsResponse.fromJson(core.Map json_)
: this(
nextPageToken: json_['nextPageToken'] as core.String?,
operations: (json_['operations'] as core.List?)
?.map(
(value) => GoogleLongrunningOperation.fromJson(
value as core.Map<core.String, core.dynamic>,
),
)
.toList(),
unreachable: (json_['unreachable'] as core.List?)
?.map((value) => value as core.String)
.toList(),
);
core.Map<core.String, core.dynamic> toJson() {
final nextPageToken = this.nextPageToken;
final operations = this.operations;
final unreachable = this.unreachable;
return {
'nextPageToken': ?nextPageToken,
'operations': ?operations,
'unreachable': ?unreachable,
};
}
}
/// This resource represents a long-running operation that is the result of a
/// network API call.
class GoogleLongrunningOperation {
/// If the value is `false`, it means the operation is still in progress.
///
/// If `true`, the operation is completed, and either `error` or `response` is
/// available.
core.bool? done;
/// The error result of the operation in case of failure or cancellation.
GoogleRpcStatus? error;
/// Service-specific metadata associated with the operation.
///
/// It typically contains progress information and common metadata such as
/// create time. Some services might not provide such metadata. Any method
/// that returns a long-running operation should document the metadata type,
/// if any.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object?>? metadata;
/// The server-assigned name, which is only unique within the same service
/// that originally returns it.
///
/// If you use the default HTTP mapping, the `name` should be a resource name
/// ending with `operations/{unique_id}`.
core.String? name;
/// The normal, successful response of the operation.
///
/// If the original method returns no data on success, such as `Delete`, the
/// response is `google.protobuf.Empty`. If the original method is standard
/// `Get`/`Create`/`Update`, the response should be the resource. For other
/// methods, the response should have the type `XxxResponse`, where `Xxx` is
/// the original method name. For example, if the original method name is
/// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object?>? response;
GoogleLongrunningOperation({
this.done,
this.error,
this.metadata,
this.name,
this.response,
});
GoogleLongrunningOperation.fromJson(core.Map json_)
: this(
done: json_['done'] as core.bool?,
error: json_.containsKey('error')
? GoogleRpcStatus.fromJson(
json_['error'] as core.Map<core.String, core.dynamic>,
)
: null,
metadata: json_.containsKey('metadata')
? json_['metadata'] as core.Map<core.String, core.dynamic>
: null,
name: json_['name'] as core.String?,
response: json_.containsKey('response')
? json_['response'] as core.Map<core.String, core.dynamic>
: null,
);
core.Map<core.String, core.dynamic> toJson() {
final done = this.done;
final error = this.error;
final metadata = this.metadata;
final name = this.name;
final response = this.response;
return {
'done': ?done,
'error': ?error,
'metadata': ?metadata,
'name': ?name,
'response': ?response,
};
}
}
/// The `Status` type defines a logical error model that is suitable for
/// different programming environments, including REST APIs and RPC APIs.
///
/// It is used by [gRPC](https://github.com/grpc). Each `Status` message
/// contains three pieces of data: error code, error message, and error details.
/// You can find out more about this error model and how to work with it in the
/// [API Design Guide](https://cloud.google.com/apis/design/errors).
typedef GoogleRpcStatus = $Status00;
/// Represents a whole or partial calendar date, such as a birthday.
///
/// The time of day and time zone are either specified elsewhere or are
/// insignificant. The date is relative to the Gregorian Calendar. This can
/// represent one of the following: * A full date, with non-zero year, month,
/// and day values. * A month and day, with a zero year (for example, an
/// anniversary). * A year on its own, with a zero month and a zero day. * A
/// year and month, with a zero day (for example, a credit card expiration
/// date). Related types: * google.type.TimeOfDay * google.type.DateTime *
/// google.protobuf.Timestamp
typedef GoogleTypeDate = $Date;
/// Represents a textual expression in the Common Expression Language (CEL)
/// syntax.
///
/// CEL is a C-like expression language. The syntax and semantics of CEL are
/// documented at https://github.com/google/cel-spec. Example (Comparison):
/// title: "Summary size limit" description: "Determines if a summary is less
/// than 100 chars" expression: "document.summary.size() \< 100" Example
/// (Equality): title: "Requestor is owner" description: "Determines if
/// requestor is the document owner" expression: "document.owner ==
/// request.auth.claims.email" Example (Logic): title: "Public documents"
/// description: "Determine whether the document should be publicly visible"
/// expression: "document.type != 'private' && document.type != 'internal'"
/// Example (Data Manipulation): title: "Notification string" description:
/// "Create a notification string with a timestamp." expression: "'New message
/// received at ' + string(document.create_time)" The exact variables and
/// functions that may be referenced within an expression are determined by the
/// service that evaluates it. See the service documentation for additional
/// information.
typedef GoogleTypeExpr = $Expr;