| // 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 |
| |
| /// Access Context Manager API - v1 |
| /// |
| /// An API for setting attribute based access control to requests to Google |
| /// Cloud services. *Warning:* Do not mix *v1alpha* and *v1* API usage in the |
| /// same access policy. The v1alpha API supports new Access Context Manager |
| /// features, which may have different attributes or behaviors that are not |
| /// supported by v1. The practice of mixed API usage within a policy may result |
| /// in the inability to update that policy, including any access levels or |
| /// service perimeters belonging to it. It is not recommended to use both v1 and |
| /// v1alpha for modifying policies with critical service perimeters. |
| /// Modifications using v1alpha should be limited to policies with |
| /// non-production/non-critical service perimeters. |
| /// |
| /// For more information, see |
| /// <https://cloud.google.com/access-context-manager/docs/reference/rest/> |
| /// |
| /// Create an instance of [AccessContextManagerApi] to access these resources: |
| /// |
| /// - [AccessPoliciesResource] |
| /// - [AccessPoliciesAccessLevelsResource] |
| /// - [AccessPoliciesAuthorizedOrgsDescsResource] |
| /// - [AccessPoliciesServicePerimetersResource] |
| /// - [OperationsResource] |
| /// - [OrganizationsResource] |
| /// - [OrganizationsGcpUserAccessBindingsResource] |
| /// - [ServicesResource] |
| 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; |
| |
| /// An API for setting attribute based access control to requests to Google |
| /// Cloud services. |
| /// |
| /// *Warning:* Do not mix *v1alpha* and *v1* API usage in the same access |
| /// policy. The v1alpha API supports new Access Context Manager features, which |
| /// may have different attributes or behaviors that are not supported by v1. The |
| /// practice of mixed API usage within a policy may result in the inability to |
| /// update that policy, including any access levels or service perimeters |
| /// belonging to it. It is not recommended to use both v1 and v1alpha for |
| /// modifying policies with critical service perimeters. Modifications using |
| /// v1alpha should be limited to policies with non-production/non-critical |
| /// service perimeters. |
| class AccessContextManagerApi { |
| /// 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; |
| |
| AccessPoliciesResource get accessPolicies => |
| AccessPoliciesResource(_requester); |
| OperationsResource get operations => OperationsResource(_requester); |
| OrganizationsResource get organizations => OrganizationsResource(_requester); |
| ServicesResource get services => ServicesResource(_requester); |
| |
| AccessContextManagerApi( |
| http.Client client, { |
| core.String rootUrl = 'https://accesscontextmanager.googleapis.com/', |
| core.String servicePath = '', |
| }) : _requester = commons.ApiRequester( |
| client, |
| rootUrl, |
| servicePath, |
| requestHeaders, |
| ); |
| } |
| |
| class AccessPoliciesResource { |
| final commons.ApiRequester _requester; |
| |
| AccessPoliciesAccessLevelsResource get accessLevels => |
| AccessPoliciesAccessLevelsResource(_requester); |
| AccessPoliciesAuthorizedOrgsDescsResource get authorizedOrgsDescs => |
| AccessPoliciesAuthorizedOrgsDescsResource(_requester); |
| AccessPoliciesServicePerimetersResource get servicePerimeters => |
| AccessPoliciesServicePerimetersResource(_requester); |
| |
| AccessPoliciesResource(commons.ApiRequester client) : _requester = client; |
| |
| /// Creates an access policy. |
| /// |
| /// This method fails if the organization already has an access policy. The |
| /// long-running operation has a successful status after the access policy |
| /// propagates to long-lasting storage. Syntactic and basic semantic errors |
| /// are returned in `metadata` as a BadRequest proto. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> create( |
| AccessPolicy request, { |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| const url_ = 'v1/accessPolicies'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Deletes an access policy based on the resource name. |
| /// |
| /// The long-running operation has a successful status after the access policy |
| /// is removed from long-lasting storage. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Resource name for the access policy to delete. Format |
| /// `accessPolicies/{policy_id}` |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> delete( |
| 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_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Returns an access policy based on the name. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Resource name for the access policy to get. Format |
| /// `accessPolicies/{policy_id}` |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [AccessPolicy]. |
| /// |
| /// 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<AccessPolicy> 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 AccessPolicy.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Gets the IAM policy for the specified Access Context Manager access |
| /// policy. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [resource] - REQUIRED: The resource for which the policy is being |
| /// requested. See |
| /// [Resource names](https://cloud.google.com/apis/design/resource_names) for |
| /// the appropriate value for this field. |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Policy]. |
| /// |
| /// 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<Policy> getIamPolicy( |
| GetIamPolicyRequest request, |
| core.String resource, { |
| 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('$resource') + ':getIamPolicy'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Policy.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Lists all access policies in an organization. |
| /// |
| /// Request parameters: |
| /// |
| /// [pageSize] - Number of AccessPolicy instances to include in the list. |
| /// Default 100. |
| /// |
| /// [pageToken] - Next page token for the next batch of AccessPolicy |
| /// instances. Defaults to the first page of results. |
| /// |
| /// [parent] - Required. Resource name for the container to list AccessPolicy |
| /// instances from. Format: `organizations/{org_id}` |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListAccessPoliciesResponse]. |
| /// |
| /// 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<ListAccessPoliciesResponse> list({ |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? parent, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'pageSize': ?pageSize == null ? null : ['${pageSize}'], |
| 'pageToken': ?pageToken == null ? null : [pageToken], |
| 'parent': ?parent == null ? null : [parent], |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| const url_ = 'v1/accessPolicies'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return ListAccessPoliciesResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Updates an access policy. |
| /// |
| /// The long-running operation from this RPC has a successful status after the |
| /// changes to the access policy propagate to long-lasting storage. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Output only. Identifier. Resource name of the `AccessPolicy`. |
| /// Format: `accessPolicies/{access_policy}` |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [updateMask] - Required. Mask to control which fields get updated. Must be |
| /// non-empty. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> patch( |
| AccessPolicy request, |
| core.String name, { |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'updateMask': ?updateMask == null ? null : [updateMask], |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Sets the IAM policy for the specified Access Context Manager access |
| /// policy. |
| /// |
| /// This method replaces the existing IAM policy on the access policy. The IAM |
| /// policy controls the set of users who can perform specific operations on |
| /// the Access Context Manager access policy. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [resource] - REQUIRED: The resource for which the policy is being |
| /// specified. See |
| /// [Resource names](https://cloud.google.com/apis/design/resource_names) for |
| /// the appropriate value for this field. |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Policy]. |
| /// |
| /// 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<Policy> setIamPolicy( |
| SetIamPolicyRequest request, |
| core.String resource, { |
| 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('$resource') + ':setIamPolicy'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Policy.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Returns the IAM permissions that the caller has on the specified Access |
| /// Context Manager resource. |
| /// |
| /// The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. |
| /// This method does not support other resources. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [resource] - REQUIRED: The resource for which the policy detail is being |
| /// requested. See |
| /// [Resource names](https://cloud.google.com/apis/design/resource_names) for |
| /// the appropriate value for this field. |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [TestIamPermissionsResponse]. |
| /// |
| /// 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<TestIamPermissionsResponse> testIamPermissions( |
| TestIamPermissionsRequest request, |
| core.String resource, { |
| 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('$resource') + ':testIamPermissions'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return TestIamPermissionsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| class AccessPoliciesAccessLevelsResource { |
| final commons.ApiRequester _requester; |
| |
| AccessPoliciesAccessLevelsResource(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Creates an access level. |
| /// |
| /// The long-running operation from this RPC has a successful status after the |
| /// access level propagates to long-lasting storage. If access levels contain |
| /// errors, an error response is returned for the first error encountered. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Resource name for the access policy which owns this |
| /// Access Level. Format: `accessPolicies/{policy_id}` |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> create( |
| AccessLevel 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') + '/accessLevels'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Deletes an access level based on the resource name. |
| /// |
| /// The long-running operation from this RPC has a successful status after the |
| /// access level has been removed from long-lasting storage. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Resource name for the Access Level. Format: |
| /// `accessPolicies/{policy_id}/accessLevels/{access_level_id}` |
| /// Value must have pattern `^accessPolicies/\[^/\]+/accessLevels/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> delete( |
| 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_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Gets an access level based on the resource name. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Resource name for the Access Level. Format: |
| /// `accessPolicies/{policy_id}/accessLevels/{access_level_id}` |
| /// Value must have pattern `^accessPolicies/\[^/\]+/accessLevels/\[^/\]+$`. |
| /// |
| /// [accessLevelFormat] - Whether to return `BasicLevels` in the Cloud Common |
| /// Expression Language rather than as `BasicLevels`. Defaults to AS_DEFINED, |
| /// where Access Levels are returned as `BasicLevels` or `CustomLevels` based |
| /// on how they were created. If set to CEL, all Access Levels are returned as |
| /// `CustomLevels`. In the CEL case, `BasicLevels` are translated to |
| /// equivalent `CustomLevels`. |
| /// Possible string values are: |
| /// - "LEVEL_FORMAT_UNSPECIFIED" : The format was not specified. |
| /// - "AS_DEFINED" : Uses the format the resource was defined in. BasicLevels |
| /// are returned as BasicLevels, CustomLevels are returned as CustomLevels. |
| /// - "CEL" : Use Cloud Common Expression Language when returning the |
| /// resource. Both BasicLevels and CustomLevels are returned as CustomLevels. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [AccessLevel]. |
| /// |
| /// 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<AccessLevel> get( |
| core.String name, { |
| core.String? accessLevelFormat, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'accessLevelFormat': ?accessLevelFormat == null |
| ? null |
| : [accessLevelFormat], |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return AccessLevel.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lists all access levels for an access policy. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Resource name for the access policy to list Access |
| /// Levels from. Format: `accessPolicies/{policy_id}` |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [accessLevelFormat] - Whether to return `BasicLevels` in the Cloud Common |
| /// Expression language, as `CustomLevels`, rather than as `BasicLevels`. |
| /// Defaults to returning `AccessLevels` in the format they were defined. |
| /// Possible string values are: |
| /// - "LEVEL_FORMAT_UNSPECIFIED" : The format was not specified. |
| /// - "AS_DEFINED" : Uses the format the resource was defined in. BasicLevels |
| /// are returned as BasicLevels, CustomLevels are returned as CustomLevels. |
| /// - "CEL" : Use Cloud Common Expression Language when returning the |
| /// resource. Both BasicLevels and CustomLevels are returned as CustomLevels. |
| /// |
| /// [pageSize] - Number of Access Levels to include in the list. Default 100. |
| /// |
| /// [pageToken] - Next page token for the next batch of Access Level |
| /// instances. Defaults to the first page of results. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListAccessLevelsResponse]. |
| /// |
| /// 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<ListAccessLevelsResponse> list( |
| core.String parent, { |
| core.String? accessLevelFormat, |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'accessLevelFormat': ?accessLevelFormat == null |
| ? null |
| : [accessLevelFormat], |
| 'pageSize': ?pageSize == null ? null : ['${pageSize}'], |
| 'pageToken': ?pageToken == null ? null : [pageToken], |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/accessLevels'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return ListAccessLevelsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Updates an access level. |
| /// |
| /// The long-running operation from this RPC has a successful status after the |
| /// changes to the access level propagate to long-lasting storage. If access |
| /// levels contain errors, an error response is returned for the first error |
| /// encountered. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Identifier. Resource name for the `AccessLevel`. Format: |
| /// `accessPolicies/{access_policy}/accessLevels/{access_level}`. The |
| /// `access_level` component must begin with a letter, followed by |
| /// alphanumeric characters or `_`. Its maximum length is 50 characters. After |
| /// you create an `AccessLevel`, you cannot change its `name`. |
| /// Value must have pattern `^accessPolicies/\[^/\]+/accessLevels/\[^/\]+$`. |
| /// |
| /// [updateMask] - Required. Mask to control which fields get updated. Must be |
| /// non-empty. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> patch( |
| AccessLevel request, |
| core.String name, { |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'updateMask': ?updateMask == null ? null : [updateMask], |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Replaces all existing access levels in an access policy with the access |
| /// levels provided. |
| /// |
| /// This is done atomically. The long-running operation from this RPC has a |
| /// successful status after all replacements propagate to long-lasting |
| /// storage. If the replacement contains errors, an error response is returned |
| /// for the first error encountered. Upon error, the replacement is cancelled, |
| /// and existing access levels are not affected. The Operation.response field |
| /// contains ReplaceAccessLevelsResponse. Removing access levels contained in |
| /// existing service perimeters result in an error. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Resource name for the access policy which owns these |
| /// Access Levels. Format: `accessPolicies/{policy_id}` |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> replaceAll( |
| ReplaceAccessLevelsRequest 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') + '/accessLevels:replaceAll'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Returns the IAM permissions that the caller has on the specified Access |
| /// Context Manager resource. |
| /// |
| /// The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. |
| /// This method does not support other resources. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [resource] - REQUIRED: The resource for which the policy detail is being |
| /// requested. See |
| /// [Resource names](https://cloud.google.com/apis/design/resource_names) for |
| /// the appropriate value for this field. |
| /// Value must have pattern `^accessPolicies/\[^/\]+/accessLevels/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [TestIamPermissionsResponse]. |
| /// |
| /// 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<TestIamPermissionsResponse> testIamPermissions( |
| TestIamPermissionsRequest request, |
| core.String resource, { |
| 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('$resource') + ':testIamPermissions'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return TestIamPermissionsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| class AccessPoliciesAuthorizedOrgsDescsResource { |
| final commons.ApiRequester _requester; |
| |
| AccessPoliciesAuthorizedOrgsDescsResource(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Creates an authorized orgs desc. |
| /// |
| /// The long-running operation from this RPC has a successful status after the |
| /// authorized orgs desc propagates to long-lasting storage. If a authorized |
| /// orgs desc contains errors, an error response is returned for the first |
| /// error encountered. The name of this `AuthorizedOrgsDesc` will be assigned |
| /// during creation. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Resource name for the access policy which owns this |
| /// Authorized Orgs Desc. Format: `accessPolicies/{policy_id}` |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> create( |
| AuthorizedOrgsDesc 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') + '/authorizedOrgsDescs'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Deletes an authorized orgs desc based on the resource name. |
| /// |
| /// The long-running operation from this RPC has a successful status after the |
| /// authorized orgs desc is removed from long-lasting storage. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Resource name for the Authorized Orgs Desc. Format: |
| /// `accessPolicies/{policy_id}/authorizedOrgsDesc/{authorized_orgs_desc_id}` |
| /// Value must have pattern |
| /// `^accessPolicies/\[^/\]+/authorizedOrgsDescs/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> delete( |
| 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_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Gets an authorized orgs desc based on the resource name. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Resource name for the Authorized Orgs Desc. Format: |
| /// `accessPolicies/{policy_id}/authorizedOrgsDescs/{authorized_orgs_descs_id}` |
| /// Value must have pattern |
| /// `^accessPolicies/\[^/\]+/authorizedOrgsDescs/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [AuthorizedOrgsDesc]. |
| /// |
| /// 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<AuthorizedOrgsDesc> 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 AuthorizedOrgsDesc.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lists all authorized orgs descs for an access policy. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Resource name for the access policy to list |
| /// Authorized Orgs Desc from. Format: `accessPolicies/{policy_id}` |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [pageSize] - Number of Authorized Orgs Descs to include in the list. |
| /// Default 100. |
| /// |
| /// [pageToken] - Next page token for the next batch of Authorized Orgs Desc |
| /// instances. Defaults to the first page of results. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListAuthorizedOrgsDescsResponse]. |
| /// |
| /// 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<ListAuthorizedOrgsDescsResponse> 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') + '/authorizedOrgsDescs'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return ListAuthorizedOrgsDescsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Updates an authorized orgs desc. |
| /// |
| /// The long-running operation from this RPC has a successful status after the |
| /// authorized orgs desc propagates to long-lasting storage. If a authorized |
| /// orgs desc contains errors, an error response is returned for the first |
| /// error encountered. Only the organization list in `AuthorizedOrgsDesc` can |
| /// be updated. The name, authorization_type, asset_type and |
| /// authorization_direction cannot be updated. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Identifier. Resource name for the `AuthorizedOrgsDesc`. Format: |
| /// `accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}`. |
| /// The `authorized_orgs_desc` component must begin with a letter, followed by |
| /// alphanumeric characters or `_`. After you create an `AuthorizedOrgsDesc`, |
| /// you cannot change its `name`. |
| /// Value must have pattern |
| /// `^accessPolicies/\[^/\]+/authorizedOrgsDescs/\[^/\]+$`. |
| /// |
| /// [updateMask] - Required. Mask to control which fields get updated. Must be |
| /// non-empty. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> patch( |
| AuthorizedOrgsDesc request, |
| core.String name, { |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'updateMask': ?updateMask == null ? null : [updateMask], |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| class AccessPoliciesServicePerimetersResource { |
| final commons.ApiRequester _requester; |
| |
| AccessPoliciesServicePerimetersResource(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Commits the dry-run specification for all the service perimeters in an |
| /// access policy. |
| /// |
| /// A commit operation on a service perimeter involves copying its `spec` |
| /// field to the `status` field of the service perimeter. Only service |
| /// perimeters with `use_explicit_dry_run_spec` field set to true are affected |
| /// by a commit operation. The long-running operation from this RPC has a |
| /// successful status after the dry-run specifications for all the service |
| /// perimeters have been committed. If a commit fails, it causes the |
| /// long-running operation to return an error response and the entire commit |
| /// operation is cancelled. When successful, the Operation.response field |
| /// contains CommitServicePerimetersResponse. The `dry_run` and the `spec` |
| /// fields are cleared after a successful commit operation. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Resource name for the parent Access Policy which owns |
| /// all Service Perimeters in scope for the commit operation. Format: |
| /// `accessPolicies/{policy_id}` |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> commit( |
| CommitServicePerimetersRequest 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') + '/servicePerimeters:commit'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Creates a service perimeter. |
| /// |
| /// The long-running operation from this RPC has a successful status after the |
| /// service perimeter propagates to long-lasting storage. If a service |
| /// perimeter contains errors, an error response is returned for the first |
| /// error encountered. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Resource name for the access policy which owns this |
| /// Service Perimeter. Format: `accessPolicies/{policy_id}` |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> create( |
| ServicePerimeter 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') + '/servicePerimeters'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Deletes a service perimeter based on the resource name. |
| /// |
| /// The long-running operation from this RPC has a successful status after the |
| /// service perimeter is removed from long-lasting storage. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Resource name for the Service Perimeter. Format: |
| /// `accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}` |
| /// Value must have pattern |
| /// `^accessPolicies/\[^/\]+/servicePerimeters/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> delete( |
| 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_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Gets a service perimeter based on the resource name. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Resource name for the Service Perimeter. Format: |
| /// `accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}` |
| /// Value must have pattern |
| /// `^accessPolicies/\[^/\]+/servicePerimeters/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ServicePerimeter]. |
| /// |
| /// 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<ServicePerimeter> 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 ServicePerimeter.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lists all service perimeters for an access policy. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Resource name for the access policy to list Service |
| /// Perimeters from. Format: `accessPolicies/{policy_id}` |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [pageSize] - Number of Service Perimeters to include in the list. Default |
| /// 100. |
| /// |
| /// [pageToken] - Next page token for the next batch of Service Perimeter |
| /// instances. Defaults to the first page of results. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListServicePerimetersResponse]. |
| /// |
| /// 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<ListServicePerimetersResponse> 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') + '/servicePerimeters'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return ListServicePerimetersResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Updates a service perimeter. |
| /// |
| /// The long-running operation from this RPC has a successful status after the |
| /// service perimeter propagates to long-lasting storage. If a service |
| /// perimeter contains errors, an error response is returned for the first |
| /// error encountered. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Identifier. Resource name for the `ServicePerimeter`. Format: |
| /// `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`. |
| /// The `service_perimeter` component must begin with a letter, followed by |
| /// alphanumeric characters or `_`. After you create a `ServicePerimeter`, you |
| /// cannot change its `name`. |
| /// Value must have pattern |
| /// `^accessPolicies/\[^/\]+/servicePerimeters/\[^/\]+$`. |
| /// |
| /// [updateMask] - Required. Mask to control which fields get updated. Must be |
| /// non-empty. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> patch( |
| ServicePerimeter request, |
| core.String name, { |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'updateMask': ?updateMask == null ? null : [updateMask], |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Replace all existing service perimeters in an access policy with the |
| /// service perimeters provided. |
| /// |
| /// This is done atomically. The long-running operation from this RPC has a |
| /// successful status after all replacements propagate to long-lasting |
| /// storage. Replacements containing errors result in an error response for |
| /// the first error encountered. Upon an error, replacement are cancelled and |
| /// existing service perimeters are not affected. The Operation.response field |
| /// contains ReplaceServicePerimetersResponse. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Resource name for the access policy which owns these |
| /// Service Perimeters. Format: `accessPolicies/{policy_id}` |
| /// Value must have pattern `^accessPolicies/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> replaceAll( |
| ReplaceServicePerimetersRequest 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') + |
| '/servicePerimeters:replaceAll'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Returns the IAM permissions that the caller has on the specified Access |
| /// Context Manager resource. |
| /// |
| /// The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. |
| /// This method does not support other resources. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [resource] - REQUIRED: The resource for which the policy detail is being |
| /// requested. See |
| /// [Resource names](https://cloud.google.com/apis/design/resource_names) for |
| /// the appropriate value for this field. |
| /// Value must have pattern |
| /// `^accessPolicies/\[^/\]+/servicePerimeters/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [TestIamPermissionsResponse]. |
| /// |
| /// 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<TestIamPermissionsResponse> testIamPermissions( |
| TestIamPermissionsRequest request, |
| core.String resource, { |
| 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('$resource') + ':testIamPermissions'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return TestIamPermissionsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| class OperationsResource { |
| final commons.ApiRequester _requester; |
| |
| OperationsResource(commons.ApiRequester client) : _requester = client; |
| |
| /// Starts asynchronous cancellation on a long-running operation. |
| /// |
| /// The server makes a best effort to cancel the operation, but success is not |
| /// guaranteed. If the server doesn't support this method, it returns |
| /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation |
| /// or other methods to check whether the cancellation succeeded or whether |
| /// the operation completed despite cancellation. On successful cancellation, |
| /// the operation is not deleted; instead, it becomes an operation with an |
| /// Operation.error value with a google.rpc.Status.code of `1`, corresponding |
| /// to `Code.CANCELLED`. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - The name of the operation resource to be cancelled. |
| /// Value must have pattern `^operations/.*$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Empty]. |
| /// |
| /// 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<Empty> cancel( |
| CancelOperationRequest request, |
| core.String name, { |
| 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('$name') + ':cancel'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Deletes a long-running operation. |
| /// |
| /// This method indicates that the client is no longer interested in the |
| /// operation result. It does not cancel the operation. If the server doesn't |
| /// support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - The name of the operation resource to be deleted. |
| /// Value must have pattern `^operations/.*$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Empty]. |
| /// |
| /// 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<Empty> delete(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_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// 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 [Operation]. |
| /// |
| /// 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<Operation> 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 Operation.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 [ListOperationsResponse]. |
| /// |
| /// 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<ListOperationsResponse> 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 ListOperationsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| class OrganizationsResource { |
| final commons.ApiRequester _requester; |
| |
| OrganizationsGcpUserAccessBindingsResource get gcpUserAccessBindings => |
| OrganizationsGcpUserAccessBindingsResource(_requester); |
| |
| OrganizationsResource(commons.ApiRequester client) : _requester = client; |
| } |
| |
| class OrganizationsGcpUserAccessBindingsResource { |
| final commons.ApiRequester _requester; |
| |
| OrganizationsGcpUserAccessBindingsResource(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Creates a GcpUserAccessBinding. |
| /// |
| /// If the client specifies a name, the server ignores it. Fails if a resource |
| /// already exists with the same group_key. Completion of this long-running |
| /// operation does not necessarily signify that the new binding is deployed |
| /// onto all affected users, which may take more time. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Example: "organizations/256" |
| /// Value must have pattern `^organizations/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> create( |
| GcpUserAccessBinding 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') + '/gcpUserAccessBindings'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'POST', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Deletes a GcpUserAccessBinding. |
| /// |
| /// Completion of this long-running operation does not necessarily signify |
| /// that the binding deletion is deployed onto all affected users, which may |
| /// take more time. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Example: |
| /// "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N" |
| /// Value must have pattern |
| /// `^organizations/\[^/\]+/gcpUserAccessBindings/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> delete( |
| 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_, |
| 'DELETE', |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Gets the GcpUserAccessBinding with the given name. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Example: |
| /// "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N" |
| /// Value must have pattern |
| /// `^organizations/\[^/\]+/gcpUserAccessBindings/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GcpUserAccessBinding]. |
| /// |
| /// 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<GcpUserAccessBinding> 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 GcpUserAccessBinding.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lists all GcpUserAccessBindings for a Google Cloud organization. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Example: "organizations/256" |
| /// Value must have pattern `^organizations/\[^/\]+$`. |
| /// |
| /// [pageSize] - Optional. Maximum number of items to return. The server may |
| /// return fewer items. If left blank, the server may return any number of |
| /// items. |
| /// |
| /// [pageToken] - Optional. If left blank, returns the first page. To |
| /// enumerate all items, use the next_page_token from your previous list |
| /// operation. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListGcpUserAccessBindingsResponse]. |
| /// |
| /// 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<ListGcpUserAccessBindingsResponse> 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') + '/gcpUserAccessBindings'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return ListGcpUserAccessBindingsResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Updates a GcpUserAccessBinding. |
| /// |
| /// Completion of this long-running operation does not necessarily signify |
| /// that the changed binding is deployed onto all affected users, which may |
| /// take more time. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Immutable. Assigned by the server during creation. The last |
| /// segment has an arbitrary length and has only URI unreserved characters (as |
| /// defined by |
| /// [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). |
| /// Should not be specified by the client during creation. Example: |
| /// "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N" |
| /// Value must have pattern |
| /// `^organizations/\[^/\]+/gcpUserAccessBindings/\[^/\]+$`. |
| /// |
| /// [append] - Optional. This field controls whether or not certain repeated |
| /// settings in the update request overwrite or append to existing settings on |
| /// the binding. If true, then append. Otherwise overwrite. So far, only |
| /// scoped_access_settings with session_settings supports appending. Global |
| /// access_levels, access_levels in scoped_access_settings, |
| /// dry_run_access_levels, and session_settings are not compatible with append |
| /// functionality, and the request will return an error if append=true when |
| /// these settings are in the update_mask. The request will also return an |
| /// error if append=true when "scoped_access_settings" is not set in the |
| /// update_mask. |
| /// |
| /// [updateMask] - Required. Only the fields specified in this mask are |
| /// updated. Because name and group_key cannot be changed, update_mask is |
| /// required and may only contain the following fields: `access_levels`, |
| /// `dry_run_access_levels`, `session_settings`, `scoped_access_settings`. |
| /// update_mask { paths: "access_levels" } |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// 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<Operation> patch( |
| GcpUserAccessBinding request, |
| core.String name, { |
| core.bool? append, |
| core.String? updateMask, |
| core.String? $fields, |
| }) async { |
| final body_ = convert.json.encode(request); |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'append': ?append == null ? null : ['${append}'], |
| 'updateMask': ?updateMask == null ? null : [updateMask], |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/' + core.Uri.encodeFull('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'PATCH', |
| body: body_, |
| queryParams: queryParams_, |
| ); |
| return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| class ServicesResource { |
| final commons.ApiRequester _requester; |
| |
| ServicesResource(commons.ApiRequester client) : _requester = client; |
| |
| /// Returns a VPC-SC supported service based on the service name. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - The name of the service to get information about. The names must |
| /// be in the same format as used in defining a service perimeter, for |
| /// example, `storage.googleapis.com`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [SupportedService]. |
| /// |
| /// 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<SupportedService> get( |
| core.String name, { |
| core.String? $fields, |
| }) async { |
| final queryParams_ = <core.String, core.List<core.String>>{ |
| 'fields': ?$fields == null ? null : [$fields], |
| }; |
| |
| final url_ = 'v1/services/' + commons.escapeVariable('$name'); |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return SupportedService.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| |
| /// Lists all VPC-SC supported services. |
| /// |
| /// Request parameters: |
| /// |
| /// [pageSize] - This flag specifies the maximum number of services to return |
| /// per page. Default is 100. |
| /// |
| /// [pageToken] - Token to start on a later page. Default is the first page. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListSupportedServicesResponse]. |
| /// |
| /// 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<ListSupportedServicesResponse> list({ |
| 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], |
| }; |
| |
| const url_ = 'v1/services'; |
| |
| final response_ = await _requester.request( |
| url_, |
| 'GET', |
| queryParams: queryParams_, |
| ); |
| return ListSupportedServicesResponse.fromJson( |
| response_ as core.Map<core.String, core.dynamic>, |
| ); |
| } |
| } |
| |
| /// An `AccessLevel` is a label that can be applied to requests to Google Cloud |
| /// services, along with a list of requirements necessary for the label to be |
| /// applied. |
| class AccessLevel { |
| /// A `BasicLevel` composed of `Conditions`. |
| BasicLevel? basic; |
| |
| /// A `CustomLevel` written in the Common Expression Language. |
| CustomLevel? custom; |
| |
| /// Description of the `AccessLevel` and its use. |
| /// |
| /// Does not affect behavior. |
| core.String? description; |
| |
| /// Identifier. |
| /// |
| /// Resource name for the `AccessLevel`. Format: |
| /// `accessPolicies/{access_policy}/accessLevels/{access_level}`. The |
| /// `access_level` component must begin with a letter, followed by |
| /// alphanumeric characters or `_`. Its maximum length is 50 characters. After |
| /// you create an `AccessLevel`, you cannot change its `name`. |
| core.String? name; |
| |
| /// Human readable title. |
| /// |
| /// Must be unique within the Policy. |
| core.String? title; |
| |
| AccessLevel({ |
| this.basic, |
| this.custom, |
| this.description, |
| this.name, |
| this.title, |
| }); |
| |
| AccessLevel.fromJson(core.Map json_) |
| : this( |
| basic: json_.containsKey('basic') |
| ? BasicLevel.fromJson( |
| json_['basic'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| custom: json_.containsKey('custom') |
| ? CustomLevel.fromJson( |
| json_['custom'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| description: json_['description'] as core.String?, |
| name: json_['name'] as core.String?, |
| title: json_['title'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final basic = this.basic; |
| final custom = this.custom; |
| final description = this.description; |
| final name = this.name; |
| final title = this.title; |
| return { |
| 'basic': ?basic, |
| 'custom': ?custom, |
| 'description': ?description, |
| 'name': ?name, |
| 'title': ?title, |
| }; |
| } |
| } |
| |
| /// `AccessPolicy` is a container for `AccessLevels` (which define the necessary |
| /// attributes to use Google Cloud services) and `ServicePerimeters` (which |
| /// define regions of services able to freely pass data within a perimeter). |
| /// |
| /// An access policy is globally visible within an organization, and the |
| /// restrictions it specifies apply to all projects within an organization. |
| typedef AccessPolicy = $AccessPolicy; |
| |
| /// Access scope represents the client scope, etc. |
| /// |
| /// to which the settings will be applied to. |
| class AccessScope { |
| /// Client scope for this access scope. |
| /// |
| /// Optional. |
| ClientScope? clientScope; |
| |
| AccessScope({this.clientScope}); |
| |
| AccessScope.fromJson(core.Map json_) |
| : this( |
| clientScope: json_.containsKey('clientScope') |
| ? ClientScope.fromJson( |
| json_['clientScope'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final clientScope = this.clientScope; |
| return {'clientScope': ?clientScope}; |
| } |
| } |
| |
| /// Access settings represent the set of conditions that must be met for access |
| /// to be granted. |
| /// |
| /// At least one of the fields must be set. |
| class AccessSettings { |
| /// Access level that a user must have to be granted access. |
| /// |
| /// Only one access level is supported, not multiple. This repeated field must |
| /// have exactly one element. Example: |
| /// "accessPolicies/9522/accessLevels/device_trusted" |
| /// |
| /// Optional. |
| core.List<core.String>? accessLevels; |
| |
| /// Session settings applied to user access on a given AccessScope. |
| /// |
| /// Optional. |
| SessionSettings? sessionSettings; |
| |
| AccessSettings({this.accessLevels, this.sessionSettings}); |
| |
| AccessSettings.fromJson(core.Map json_) |
| : this( |
| accessLevels: (json_['accessLevels'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| sessionSettings: json_.containsKey('sessionSettings') |
| ? SessionSettings.fromJson( |
| json_['sessionSettings'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final accessLevels = this.accessLevels; |
| final sessionSettings = this.sessionSettings; |
| return {'accessLevels': ?accessLevels, 'sessionSettings': ?sessionSettings}; |
| } |
| } |
| |
| /// Identification for an API Operation. |
| class ApiOperation { |
| /// API methods or permissions to allow. |
| /// |
| /// Method or permission must belong to the service specified by |
| /// `service_name` field. A single MethodSelector entry with `*` specified for |
| /// the `method` field will allow all methods AND permissions for the service |
| /// specified in `service_name`. |
| core.List<MethodSelector>? methodSelectors; |
| |
| /// The name of the API whose methods or permissions the IngressPolicy or |
| /// EgressPolicy want to allow. |
| /// |
| /// A single ApiOperation with `service_name` field set to `*` will allow all |
| /// methods AND permissions for all services. |
| core.String? serviceName; |
| |
| ApiOperation({this.methodSelectors, this.serviceName}); |
| |
| ApiOperation.fromJson(core.Map json_) |
| : this( |
| methodSelectors: (json_['methodSelectors'] as core.List?) |
| ?.map( |
| (value) => MethodSelector.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| serviceName: json_['serviceName'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final methodSelectors = this.methodSelectors; |
| final serviceName = this.serviceName; |
| return {'methodSelectors': ?methodSelectors, 'serviceName': ?serviceName}; |
| } |
| } |
| |
| /// An application that accesses Google Cloud APIs. |
| class Application { |
| /// The OAuth client ID of the application. |
| core.String? clientId; |
| |
| /// The name of the application. |
| /// |
| /// Example: "Cloud Console" |
| core.String? name; |
| |
| Application({this.clientId, this.name}); |
| |
| Application.fromJson(core.Map json_) |
| : this( |
| clientId: json_['clientId'] as core.String?, |
| name: json_['name'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final clientId = this.clientId; |
| final name = this.name; |
| return {'clientId': ?clientId, 'name': ?name}; |
| } |
| } |
| |
| /// 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 AuditConfig { |
| /// The configuration for logging of each type of permission. |
| core.List<AuditLogConfig>? 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; |
| |
| AuditConfig({this.auditLogConfigs, this.service}); |
| |
| AuditConfig.fromJson(core.Map json_) |
| : this( |
| auditLogConfigs: (json_['auditLogConfigs'] as core.List?) |
| ?.map( |
| (value) => AuditLogConfig.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 AuditLogConfig = $AuditLogConfig; |
| |
| /// `AuthorizedOrgsDesc` contains data for an organization's authorization |
| /// policy. |
| class AuthorizedOrgsDesc { |
| /// The asset type of this authorized orgs desc. |
| /// |
| /// Valid values are `ASSET_TYPE_DEVICE`, and |
| /// `ASSET_TYPE_CREDENTIAL_STRENGTH`. |
| /// Possible string values are: |
| /// - "ASSET_TYPE_UNSPECIFIED" : No asset type specified. |
| /// - "ASSET_TYPE_DEVICE" : Device asset type. |
| /// - "ASSET_TYPE_CREDENTIAL_STRENGTH" : Credential strength asset type. |
| core.String? assetType; |
| |
| /// The direction of the authorization relationship between this organization |
| /// and the organizations listed in the `orgs` field. |
| /// |
| /// The valid values for this field include the following: |
| /// `AUTHORIZATION_DIRECTION_FROM`: Allows this organization to evaluate |
| /// traffic in the organizations listed in the `orgs` field. |
| /// `AUTHORIZATION_DIRECTION_TO`: Allows the organizations listed in the |
| /// `orgs` field to evaluate the traffic in this organization. For the |
| /// authorization relationship to take effect, all of the organizations must |
| /// authorize and specify the appropriate relationship direction. For example, |
| /// if organization A authorized organization B and C to evaluate its traffic, |
| /// by specifying `AUTHORIZATION_DIRECTION_TO` as the authorization direction, |
| /// organizations B and C must specify `AUTHORIZATION_DIRECTION_FROM` as the |
| /// authorization direction in their `AuthorizedOrgsDesc` resource. |
| /// Possible string values are: |
| /// - "AUTHORIZATION_DIRECTION_UNSPECIFIED" : No direction specified. |
| /// - "AUTHORIZATION_DIRECTION_TO" : The specified organizations are |
| /// authorized to evaluate traffic in this organization. |
| /// - "AUTHORIZATION_DIRECTION_FROM" : The traffic of the specified |
| /// organizations can be evaluated by this organization. |
| core.String? authorizationDirection; |
| |
| /// A granular control type for authorization levels. |
| /// |
| /// Valid value is `AUTHORIZATION_TYPE_TRUST`. |
| /// Possible string values are: |
| /// - "AUTHORIZATION_TYPE_UNSPECIFIED" : No authorization type specified. |
| /// - "AUTHORIZATION_TYPE_TRUST" : This authorization relationship is "trust". |
| core.String? authorizationType; |
| |
| /// Identifier. |
| /// |
| /// Resource name for the `AuthorizedOrgsDesc`. Format: |
| /// `accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}`. |
| /// The `authorized_orgs_desc` component must begin with a letter, followed by |
| /// alphanumeric characters or `_`. After you create an `AuthorizedOrgsDesc`, |
| /// you cannot change its `name`. |
| core.String? name; |
| |
| /// The list of organization ids in this AuthorizedOrgsDesc. |
| /// |
| /// Format: `organizations/` Example: `organizations/123456` |
| core.List<core.String>? orgs; |
| |
| AuthorizedOrgsDesc({ |
| this.assetType, |
| this.authorizationDirection, |
| this.authorizationType, |
| this.name, |
| this.orgs, |
| }); |
| |
| AuthorizedOrgsDesc.fromJson(core.Map json_) |
| : this( |
| assetType: json_['assetType'] as core.String?, |
| authorizationDirection: json_['authorizationDirection'] as core.String?, |
| authorizationType: json_['authorizationType'] as core.String?, |
| name: json_['name'] as core.String?, |
| orgs: (json_['orgs'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final assetType = this.assetType; |
| final authorizationDirection = this.authorizationDirection; |
| final authorizationType = this.authorizationType; |
| final name = this.name; |
| final orgs = this.orgs; |
| return { |
| 'assetType': ?assetType, |
| 'authorizationDirection': ?authorizationDirection, |
| 'authorizationType': ?authorizationType, |
| 'name': ?name, |
| 'orgs': ?orgs, |
| }; |
| } |
| } |
| |
| /// `BasicLevel` is an `AccessLevel` using a set of recommended features. |
| class BasicLevel { |
| /// How the `conditions` list should be combined to determine if a request is |
| /// granted this `AccessLevel`. |
| /// |
| /// If AND is used, each `Condition` in `conditions` must be satisfied for the |
| /// `AccessLevel` to be applied. If OR is used, at least one `Condition` in |
| /// `conditions` must be satisfied for the `AccessLevel` to be applied. |
| /// Default behavior is AND. |
| /// Possible string values are: |
| /// - "AND" : All `Conditions` must be true for the `BasicLevel` to be true. |
| /// - "OR" : If at least one `Condition` is true, then the `BasicLevel` is |
| /// true. |
| core.String? combiningFunction; |
| |
| /// A list of requirements for the `AccessLevel` to be granted. |
| /// |
| /// Required. |
| core.List<Condition>? conditions; |
| |
| BasicLevel({this.combiningFunction, this.conditions}); |
| |
| BasicLevel.fromJson(core.Map json_) |
| : this( |
| combiningFunction: json_['combiningFunction'] as core.String?, |
| conditions: (json_['conditions'] as core.List?) |
| ?.map( |
| (value) => Condition.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final combiningFunction = this.combiningFunction; |
| final conditions = this.conditions; |
| return {'combiningFunction': ?combiningFunction, 'conditions': ?conditions}; |
| } |
| } |
| |
| /// Associates `members`, or principals, with a `role`. |
| class Binding { |
| /// 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). |
| Expr? 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; |
| |
| Binding({this.condition, this.members, this.role}); |
| |
| Binding.fromJson(core.Map json_) |
| : this( |
| condition: json_.containsKey('condition') |
| ? Expr.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}; |
| } |
| } |
| |
| /// The request message for Operations.CancelOperation. |
| typedef CancelOperationRequest = $Empty; |
| |
| /// Client scope represents the application, etc. |
| /// |
| /// subject to this binding's restrictions. |
| class ClientScope { |
| /// The application that is subject to this binding's scope. |
| /// |
| /// Optional. |
| Application? restrictedClientApplication; |
| |
| ClientScope({this.restrictedClientApplication}); |
| |
| ClientScope.fromJson(core.Map json_) |
| : this( |
| restrictedClientApplication: |
| json_.containsKey('restrictedClientApplication') |
| ? Application.fromJson( |
| json_['restrictedClientApplication'] |
| as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final restrictedClientApplication = this.restrictedClientApplication; |
| return {'restrictedClientApplication': ?restrictedClientApplication}; |
| } |
| } |
| |
| /// A request to commit dry-run specs in all Service Perimeters belonging to an |
| /// Access Policy. |
| class CommitServicePerimetersRequest { |
| /// The etag for the version of the Access Policy that this commit operation |
| /// is to be performed on. |
| /// |
| /// If, at the time of commit, the etag for the Access Policy stored in Access |
| /// Context Manager is different from the specified etag, then the commit |
| /// operation will not be performed and the call will fail. This field is not |
| /// required. If etag is not provided, the operation will be performed as if a |
| /// valid etag is provided. |
| /// |
| /// Optional. |
| core.String? etag; |
| |
| CommitServicePerimetersRequest({this.etag}); |
| |
| CommitServicePerimetersRequest.fromJson(core.Map json_) |
| : this(etag: json_['etag'] as core.String?); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final etag = this.etag; |
| return {'etag': ?etag}; |
| } |
| } |
| |
| /// A condition necessary for an `AccessLevel` to be granted. |
| /// |
| /// The Condition is an AND over its fields. So a Condition is true if: 1) the |
| /// request IP is from one of the listed subnetworks AND 2) the originating |
| /// device complies with the listed device policy AND 3) all listed access |
| /// levels are granted AND 4) the request was sent at a time allowed by the |
| /// DateTimeRestriction. |
| class Condition { |
| /// Device specific restrictions, all restrictions must hold for the Condition |
| /// to be true. |
| /// |
| /// If not specified, all devices are allowed. |
| DevicePolicy? devicePolicy; |
| |
| /// CIDR block IP subnetwork specification. |
| /// |
| /// May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified |
| /// IP address portion must be properly truncated (i.e. all the host bits must |
| /// be zero) or the input is considered malformed. For example, "192.0.2.0/24" |
| /// is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, |
| /// "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The |
| /// originating IP of a request must be in one of the listed subnets in order |
| /// for this Condition to be true. If empty, all IP addresses are allowed. |
| core.List<core.String>? ipSubnetworks; |
| |
| /// The request must be made by one of the provided user or service accounts. |
| /// |
| /// Groups are not supported. Syntax: `user:{emailid}` |
| /// `serviceAccount:{emailid}` If not specified, a request may come from any |
| /// user. |
| core.List<core.String>? members; |
| |
| /// Whether to negate the Condition. |
| /// |
| /// If true, the Condition becomes a NAND over its non-empty fields. Any |
| /// non-empty field criteria evaluating to false will result in the Condition |
| /// to be satisfied. Defaults to false. |
| core.bool? negate; |
| |
| /// The request must originate from one of the provided countries/regions. |
| /// |
| /// Must be valid ISO 3166-1 alpha-2 codes. |
| core.List<core.String>? regions; |
| |
| /// A list of other access levels defined in the same `Policy`, referenced by |
| /// resource name. |
| /// |
| /// Referencing an `AccessLevel` which does not exist is an error. All access |
| /// levels listed must be granted for the Condition to be true. Example: |
| /// "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` |
| core.List<core.String>? requiredAccessLevels; |
| |
| /// The request must originate from one of the provided VPC networks in Google |
| /// Cloud. |
| /// |
| /// Cannot specify this field together with `ip_subnetworks`. |
| core.List<VpcNetworkSource>? vpcNetworkSources; |
| |
| Condition({ |
| this.devicePolicy, |
| this.ipSubnetworks, |
| this.members, |
| this.negate, |
| this.regions, |
| this.requiredAccessLevels, |
| this.vpcNetworkSources, |
| }); |
| |
| Condition.fromJson(core.Map json_) |
| : this( |
| devicePolicy: json_.containsKey('devicePolicy') |
| ? DevicePolicy.fromJson( |
| json_['devicePolicy'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ipSubnetworks: (json_['ipSubnetworks'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| members: (json_['members'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| negate: json_['negate'] as core.bool?, |
| regions: (json_['regions'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| requiredAccessLevels: (json_['requiredAccessLevels'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| vpcNetworkSources: (json_['vpcNetworkSources'] as core.List?) |
| ?.map( |
| (value) => VpcNetworkSource.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final devicePolicy = this.devicePolicy; |
| final ipSubnetworks = this.ipSubnetworks; |
| final members = this.members; |
| final negate = this.negate; |
| final regions = this.regions; |
| final requiredAccessLevels = this.requiredAccessLevels; |
| final vpcNetworkSources = this.vpcNetworkSources; |
| return { |
| 'devicePolicy': ?devicePolicy, |
| 'ipSubnetworks': ?ipSubnetworks, |
| 'members': ?members, |
| 'negate': ?negate, |
| 'regions': ?regions, |
| 'requiredAccessLevels': ?requiredAccessLevels, |
| 'vpcNetworkSources': ?vpcNetworkSources, |
| }; |
| } |
| } |
| |
| /// `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language |
| /// to represent the necessary conditions for the level to apply to a request. |
| /// |
| /// See CEL spec at: https://github.com/google/cel-spec |
| class CustomLevel { |
| /// A Cloud CEL expression evaluating to a boolean. |
| /// |
| /// Required. |
| Expr? expr; |
| |
| CustomLevel({this.expr}); |
| |
| CustomLevel.fromJson(core.Map json_) |
| : this( |
| expr: json_.containsKey('expr') |
| ? Expr.fromJson( |
| json_['expr'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final expr = this.expr; |
| return {'expr': ?expr}; |
| } |
| } |
| |
| /// `DevicePolicy` specifies device specific restrictions necessary to acquire a |
| /// given access level. |
| /// |
| /// A `DevicePolicy` specifies requirements for requests from devices to be |
| /// granted access levels, it does not do any enforcement on the device. |
| /// `DevicePolicy` acts as an AND over all specified fields, and each repeated |
| /// field is an OR over its elements. Any unset fields are ignored. For example, |
| /// if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, |
| /// encryption_status: ENCRYPTED}, then the DevicePolicy will be true for |
| /// requests originating from encrypted Linux desktops and encrypted Windows |
| /// desktops. |
| class DevicePolicy { |
| /// Allowed device management levels, an empty list allows all management |
| /// levels. |
| core.List<core.String>? allowedDeviceManagementLevels; |
| |
| /// Allowed encryptions statuses, an empty list allows all statuses. |
| core.List<core.String>? allowedEncryptionStatuses; |
| |
| /// Allowed OS versions, an empty list allows all types and all versions. |
| core.List<OsConstraint>? osConstraints; |
| |
| /// Whether the device needs to be approved by the customer admin. |
| core.bool? requireAdminApproval; |
| |
| /// Whether the device needs to be corp owned. |
| core.bool? requireCorpOwned; |
| |
| /// Whether or not screenlock is required for the DevicePolicy to be true. |
| /// |
| /// Defaults to `false`. |
| core.bool? requireScreenlock; |
| |
| DevicePolicy({ |
| this.allowedDeviceManagementLevels, |
| this.allowedEncryptionStatuses, |
| this.osConstraints, |
| this.requireAdminApproval, |
| this.requireCorpOwned, |
| this.requireScreenlock, |
| }); |
| |
| DevicePolicy.fromJson(core.Map json_) |
| : this( |
| allowedDeviceManagementLevels: |
| (json_['allowedDeviceManagementLevels'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| allowedEncryptionStatuses: |
| (json_['allowedEncryptionStatuses'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| osConstraints: (json_['osConstraints'] as core.List?) |
| ?.map( |
| (value) => OsConstraint.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| requireAdminApproval: json_['requireAdminApproval'] as core.bool?, |
| requireCorpOwned: json_['requireCorpOwned'] as core.bool?, |
| requireScreenlock: json_['requireScreenlock'] as core.bool?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final allowedDeviceManagementLevels = this.allowedDeviceManagementLevels; |
| final allowedEncryptionStatuses = this.allowedEncryptionStatuses; |
| final osConstraints = this.osConstraints; |
| final requireAdminApproval = this.requireAdminApproval; |
| final requireCorpOwned = this.requireCorpOwned; |
| final requireScreenlock = this.requireScreenlock; |
| return { |
| 'allowedDeviceManagementLevels': ?allowedDeviceManagementLevels, |
| 'allowedEncryptionStatuses': ?allowedEncryptionStatuses, |
| 'osConstraints': ?osConstraints, |
| 'requireAdminApproval': ?requireAdminApproval, |
| 'requireCorpOwned': ?requireCorpOwned, |
| 'requireScreenlock': ?requireScreenlock, |
| }; |
| } |
| } |
| |
| /// Defines the conditions under which an EgressPolicy matches a request. |
| /// |
| /// Conditions based on information about the source of the request. Note that |
| /// if the destination of the request is also protected by a ServicePerimeter, |
| /// then that ServicePerimeter must have an IngressPolicy which allows access in |
| /// order for this request to succeed. |
| class EgressFrom { |
| /// A list of identities that are allowed access through \[EgressPolicy\]. |
| /// |
| /// Identities can be an individual user, service account, Google group, or |
| /// third-party identity. For third-party identity, only single identities are |
| /// supported and other identity types are not supported. The `v1` identities |
| /// that have the prefix `user`, `group`, `serviceAccount`, and `principal` in |
| /// https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. |
| core.List<core.String>? identities; |
| |
| /// Specifies the type of identities that are allowed access to outside the |
| /// perimeter. |
| /// |
| /// If left unspecified, then members of `identities` field will be allowed |
| /// access. |
| /// Possible string values are: |
| /// - "IDENTITY_TYPE_UNSPECIFIED" : No blanket identity group specified. |
| /// - "ANY_IDENTITY" : Authorize access from all identities outside the |
| /// perimeter. |
| /// - "ANY_USER_ACCOUNT" : Authorize access from all human users outside the |
| /// perimeter. |
| /// - "ANY_SERVICE_ACCOUNT" : Authorize access from all service accounts |
| /// outside the perimeter. |
| core.String? identityType; |
| |
| /// Whether to enforce traffic restrictions based on `sources` field. |
| /// |
| /// If the `sources` fields is non-empty, then this field must be set to |
| /// `SOURCE_RESTRICTION_ENABLED`. |
| /// Possible string values are: |
| /// - "SOURCE_RESTRICTION_UNSPECIFIED" : Enforcement preference unspecified, |
| /// will not enforce traffic restrictions based on `sources` in EgressFrom. |
| /// - "SOURCE_RESTRICTION_ENABLED" : Enforcement preference enabled, traffic |
| /// restrictions will be enforced based on `sources` in EgressFrom. |
| /// - "SOURCE_RESTRICTION_DISABLED" : Enforcement preference disabled, will |
| /// not enforce traffic restrictions based on `sources` in EgressFrom. |
| core.String? sourceRestriction; |
| |
| /// Sources that this EgressPolicy authorizes access from. |
| /// |
| /// If this field is not empty, then `source_restriction` must be set to |
| /// `SOURCE_RESTRICTION_ENABLED`. |
| core.List<EgressSource>? sources; |
| |
| EgressFrom({ |
| this.identities, |
| this.identityType, |
| this.sourceRestriction, |
| this.sources, |
| }); |
| |
| EgressFrom.fromJson(core.Map json_) |
| : this( |
| identities: (json_['identities'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| identityType: json_['identityType'] as core.String?, |
| sourceRestriction: json_['sourceRestriction'] as core.String?, |
| sources: (json_['sources'] as core.List?) |
| ?.map( |
| (value) => EgressSource.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final identities = this.identities; |
| final identityType = this.identityType; |
| final sourceRestriction = this.sourceRestriction; |
| final sources = this.sources; |
| return { |
| 'identities': ?identities, |
| 'identityType': ?identityType, |
| 'sourceRestriction': ?sourceRestriction, |
| 'sources': ?sources, |
| }; |
| } |
| } |
| |
| /// Policy for egress from perimeter. |
| /// |
| /// EgressPolicies match requests based on `egress_from` and `egress_to` |
| /// stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` |
| /// stanzas must be matched. If an EgressPolicy matches a request, the request |
| /// is allowed to span the ServicePerimeter boundary. For example, an |
| /// EgressPolicy can be used to allow VMs on networks within the |
| /// ServicePerimeter to access a defined set of projects outside the perimeter |
| /// in certain contexts (e.g. to read data from a Cloud Storage bucket or query |
| /// against a BigQuery dataset). EgressPolicies are concerned with the |
| /// *resources* that a request relates as well as the API services and API |
| /// actions being used. They do not related to the direction of data movement. |
| /// More detailed documentation for this concept can be found in the |
| /// descriptions of EgressFrom and EgressTo. |
| class EgressPolicy { |
| /// Defines conditions on the source of a request causing this EgressPolicy to |
| /// apply. |
| EgressFrom? egressFrom; |
| |
| /// Defines the conditions on the ApiOperation and destination resources that |
| /// cause this EgressPolicy to apply. |
| EgressTo? egressTo; |
| |
| /// Human-readable title for the egress rule. |
| /// |
| /// The title must be unique within the perimeter and can not exceed 100 |
| /// characters. Within the access policy, the combined length of all rule |
| /// titles must not exceed 240,000 characters. |
| /// |
| /// Optional. |
| core.String? title; |
| |
| EgressPolicy({this.egressFrom, this.egressTo, this.title}); |
| |
| EgressPolicy.fromJson(core.Map json_) |
| : this( |
| egressFrom: json_.containsKey('egressFrom') |
| ? EgressFrom.fromJson( |
| json_['egressFrom'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| egressTo: json_.containsKey('egressTo') |
| ? EgressTo.fromJson( |
| json_['egressTo'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| title: json_['title'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final egressFrom = this.egressFrom; |
| final egressTo = this.egressTo; |
| final title = this.title; |
| return {'egressFrom': ?egressFrom, 'egressTo': ?egressTo, 'title': ?title}; |
| } |
| } |
| |
| /// The source that EgressPolicy authorizes access from inside the |
| /// ServicePerimeter to somewhere outside the ServicePerimeter boundaries. |
| typedef EgressSource = $EgressSource; |
| |
| /// Defines the conditions under which an EgressPolicy matches a request. |
| /// |
| /// Conditions are based on information about the ApiOperation intended to be |
| /// performed on the `resources` specified. Note that if the destination of the |
| /// request is also protected by a ServicePerimeter, then that ServicePerimeter |
| /// must have an IngressPolicy which allows access in order for this request to |
| /// succeed. The request must match `operations` AND `resources` fields in order |
| /// to be allowed egress out of the perimeter. |
| class EgressTo { |
| /// A list of external resources that are allowed to be accessed. |
| /// |
| /// Only AWS and Azure resources are supported. For Amazon S3, the supported |
| /// formats are s3://BUCKET_NAME, s3a://BUCKET_NAME, and s3n://BUCKET_NAME. |
| /// For Azure Storage, the supported format is |
| /// azure://myaccount.blob.core.windows.net/CONTAINER_NAME. A request matches |
| /// if it contains an external resource in this list (Example: |
| /// s3://bucket/path). Currently '*' is not allowed. |
| core.List<core.String>? externalResources; |
| |
| /// A list of ApiOperations allowed to be performed by the sources specified |
| /// in the corresponding EgressFrom. |
| /// |
| /// A request matches if it uses an operation/service in this list. |
| core.List<ApiOperation>? operations; |
| |
| /// A list of resources, currently only projects in the form `projects/`, that |
| /// are allowed to be accessed by sources defined in the corresponding |
| /// EgressFrom. |
| /// |
| /// A request matches if it contains a resource in this list. If `*` is |
| /// specified for `resources`, then this EgressTo rule will authorize access |
| /// to all resources outside the perimeter. |
| core.List<core.String>? resources; |
| |
| /// IAM roles that represent the set of operations that the sources specified |
| /// in the corresponding EgressFrom. |
| /// |
| /// are allowed to perform in this ServicePerimeter. |
| core.List<core.String>? roles; |
| |
| EgressTo({ |
| this.externalResources, |
| this.operations, |
| this.resources, |
| this.roles, |
| }); |
| |
| EgressTo.fromJson(core.Map json_) |
| : this( |
| externalResources: (json_['externalResources'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| operations: (json_['operations'] as core.List?) |
| ?.map( |
| (value) => ApiOperation.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| resources: (json_['resources'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| roles: (json_['roles'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final externalResources = this.externalResources; |
| final operations = this.operations; |
| final resources = this.resources; |
| final roles = this.roles; |
| return { |
| 'externalResources': ?externalResources, |
| 'operations': ?operations, |
| 'resources': ?resources, |
| 'roles': ?roles, |
| }; |
| } |
| } |
| |
| /// A generic empty message that you can re-use to avoid defining duplicated |
| /// empty messages in your APIs. |
| /// |
| /// A typical example is to use it as the request or the response type of an API |
| /// method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns |
| /// (google.protobuf.Empty); } |
| typedef Empty = $Empty; |
| |
| /// 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 Expr = $Expr; |
| |
| /// Restricts access to Cloud Console and Google Cloud APIs for a set of users |
| /// using Context-Aware Access. |
| class GcpUserAccessBinding { |
| /// Access level that a user must have to be granted access. |
| /// |
| /// Only one access level is supported, not multiple. This repeated field must |
| /// have exactly one element. Example: |
| /// "accessPolicies/9522/accessLevels/device_trusted" |
| /// |
| /// Optional. |
| core.List<core.String>? accessLevels; |
| |
| /// Dry run access level that will be evaluated but will not be enforced. |
| /// |
| /// The access denial based on dry run policy will be logged. Only one access |
| /// level is supported, not multiple. This list must have exactly one element. |
| /// Example: "accessPolicies/9522/accessLevels/device_trusted" |
| /// |
| /// Optional. |
| core.List<core.String>? dryRunAccessLevels; |
| |
| /// Google Group id whose users are subject to this binding's restrictions. |
| /// |
| /// See "id" in the |
| /// [Google Workspace Directory API's Group Resource](https://developers.google.com/admin-sdk/directory/v1/reference/groups#resource). |
| /// If a group's email address/alias is changed, this resource will continue |
| /// to point at the changed group. This field does not accept group email |
| /// addresses or aliases. Example: "01d520gv4vjcrht" |
| /// |
| /// Optional. Immutable. |
| core.String? groupKey; |
| |
| /// Assigned by the server during creation. |
| /// |
| /// The last segment has an arbitrary length and has only URI unreserved |
| /// characters (as defined by |
| /// [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). |
| /// Should not be specified by the client during creation. Example: |
| /// "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N" |
| /// |
| /// Immutable. |
| core.String? name; |
| |
| /// A list of applications that are subject to this binding's restrictions. |
| /// |
| /// If the list is empty, the binding restrictions will universally apply to |
| /// all applications. |
| /// |
| /// Optional. |
| core.List<Application>? restrictedClientApplications; |
| |
| /// A list of scoped access settings that set this binding's restrictions on a |
| /// subset of applications. |
| /// |
| /// This field cannot be set if restricted_client_applications is set. |
| /// |
| /// Optional. |
| core.List<ScopedAccessSettings>? scopedAccessSettings; |
| |
| /// The Google Cloud session length (GCSL) policy for the group key. |
| /// |
| /// Optional. |
| SessionSettings? sessionSettings; |
| |
| GcpUserAccessBinding({ |
| this.accessLevels, |
| this.dryRunAccessLevels, |
| this.groupKey, |
| this.name, |
| this.restrictedClientApplications, |
| this.scopedAccessSettings, |
| this.sessionSettings, |
| }); |
| |
| GcpUserAccessBinding.fromJson(core.Map json_) |
| : this( |
| accessLevels: (json_['accessLevels'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| dryRunAccessLevels: (json_['dryRunAccessLevels'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| groupKey: json_['groupKey'] as core.String?, |
| name: json_['name'] as core.String?, |
| restrictedClientApplications: |
| (json_['restrictedClientApplications'] as core.List?) |
| ?.map( |
| (value) => Application.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| scopedAccessSettings: (json_['scopedAccessSettings'] as core.List?) |
| ?.map( |
| (value) => ScopedAccessSettings.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| sessionSettings: json_.containsKey('sessionSettings') |
| ? SessionSettings.fromJson( |
| json_['sessionSettings'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final accessLevels = this.accessLevels; |
| final dryRunAccessLevels = this.dryRunAccessLevels; |
| final groupKey = this.groupKey; |
| final name = this.name; |
| final restrictedClientApplications = this.restrictedClientApplications; |
| final scopedAccessSettings = this.scopedAccessSettings; |
| final sessionSettings = this.sessionSettings; |
| return { |
| 'accessLevels': ?accessLevels, |
| 'dryRunAccessLevels': ?dryRunAccessLevels, |
| 'groupKey': ?groupKey, |
| 'name': ?name, |
| 'restrictedClientApplications': ?restrictedClientApplications, |
| 'scopedAccessSettings': ?scopedAccessSettings, |
| 'sessionSettings': ?sessionSettings, |
| }; |
| } |
| } |
| |
| /// Request message for `GetIamPolicy` method. |
| class GetIamPolicyRequest { |
| /// OPTIONAL: A `GetPolicyOptions` object for specifying options to |
| /// `GetIamPolicy`. |
| GetPolicyOptions? options; |
| |
| GetIamPolicyRequest({this.options}); |
| |
| GetIamPolicyRequest.fromJson(core.Map json_) |
| : this( |
| options: json_.containsKey('options') |
| ? GetPolicyOptions.fromJson( |
| json_['options'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final options = this.options; |
| return {'options': ?options}; |
| } |
| } |
| |
| /// Encapsulates settings provided to GetIamPolicy. |
| typedef GetPolicyOptions = $GetPolicyOptions00; |
| |
| /// Defines the conditions under which an IngressPolicy matches a request. |
| /// |
| /// Conditions are based on information about the source of the request. The |
| /// request must satisfy what is defined in `sources` AND identity related |
| /// fields in order to match. |
| class IngressFrom { |
| /// A list of identities that are allowed access through \[IngressPolicy\]. |
| /// |
| /// Identities can be an individual user, service account, Google group, or |
| /// third-party identity. For third-party identity, only single identities are |
| /// supported and other identity types are not supported. The `v1` identities |
| /// that have the prefix `user`, `group`, `serviceAccount`, and `principal` in |
| /// https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. |
| core.List<core.String>? identities; |
| |
| /// Specifies the type of identities that are allowed access from outside the |
| /// perimeter. |
| /// |
| /// If left unspecified, then members of `identities` field will be allowed |
| /// access. |
| /// Possible string values are: |
| /// - "IDENTITY_TYPE_UNSPECIFIED" : No blanket identity group specified. |
| /// - "ANY_IDENTITY" : Authorize access from all identities outside the |
| /// perimeter. |
| /// - "ANY_USER_ACCOUNT" : Authorize access from all human users outside the |
| /// perimeter. |
| /// - "ANY_SERVICE_ACCOUNT" : Authorize access from all service accounts |
| /// outside the perimeter. |
| core.String? identityType; |
| |
| /// Sources that this IngressPolicy authorizes access from. |
| core.List<IngressSource>? sources; |
| |
| IngressFrom({this.identities, this.identityType, this.sources}); |
| |
| IngressFrom.fromJson(core.Map json_) |
| : this( |
| identities: (json_['identities'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| identityType: json_['identityType'] as core.String?, |
| sources: (json_['sources'] as core.List?) |
| ?.map( |
| (value) => IngressSource.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final identities = this.identities; |
| final identityType = this.identityType; |
| final sources = this.sources; |
| return { |
| 'identities': ?identities, |
| 'identityType': ?identityType, |
| 'sources': ?sources, |
| }; |
| } |
| } |
| |
| /// Policy for ingress into ServicePerimeter. |
| /// |
| /// IngressPolicies match requests based on `ingress_from` and `ingress_to` |
| /// stanzas. For an ingress policy to match, both the `ingress_from` and |
| /// `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, |
| /// the request is allowed through the perimeter boundary from outside the |
| /// perimeter. For example, access from the internet can be allowed either based |
| /// on an AccessLevel or, for traffic hosted on Google Cloud, the project of the |
| /// source network. For access from private networks, using the project of the |
| /// hosting network is required. Individual ingress policies can be limited by |
| /// restricting which services and/or actions they match using the `ingress_to` |
| /// field. |
| class IngressPolicy { |
| /// Defines the conditions on the source of a request causing this |
| /// IngressPolicy to apply. |
| IngressFrom? ingressFrom; |
| |
| /// Defines the conditions on the ApiOperation and request destination that |
| /// cause this IngressPolicy to apply. |
| IngressTo? ingressTo; |
| |
| /// Human-readable title for the ingress rule. |
| /// |
| /// The title must be unique within the perimeter and can not exceed 100 |
| /// characters. Within the access policy, the combined length of all rule |
| /// titles must not exceed 240,000 characters. |
| /// |
| /// Optional. |
| core.String? title; |
| |
| IngressPolicy({this.ingressFrom, this.ingressTo, this.title}); |
| |
| IngressPolicy.fromJson(core.Map json_) |
| : this( |
| ingressFrom: json_.containsKey('ingressFrom') |
| ? IngressFrom.fromJson( |
| json_['ingressFrom'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ingressTo: json_.containsKey('ingressTo') |
| ? IngressTo.fromJson( |
| json_['ingressTo'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| title: json_['title'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final ingressFrom = this.ingressFrom; |
| final ingressTo = this.ingressTo; |
| final title = this.title; |
| return { |
| 'ingressFrom': ?ingressFrom, |
| 'ingressTo': ?ingressTo, |
| 'title': ?title, |
| }; |
| } |
| } |
| |
| /// The source that IngressPolicy authorizes access from. |
| typedef IngressSource = $IngressSource; |
| |
| /// Defines the conditions under which an IngressPolicy matches a request. |
| /// |
| /// Conditions are based on information about the ApiOperation intended to be |
| /// performed on the target resource of the request. The request must satisfy |
| /// what is defined in `operations` AND `resources` in order to match. |
| class IngressTo { |
| /// A list of ApiOperations allowed to be performed by the sources specified |
| /// in corresponding IngressFrom in this ServicePerimeter. |
| core.List<ApiOperation>? operations; |
| |
| /// A list of resources, currently only projects in the form `projects/`, |
| /// protected by this ServicePerimeter that are allowed to be accessed by |
| /// sources defined in the corresponding IngressFrom. |
| /// |
| /// If a single `*` is specified, then access to all resources inside the |
| /// perimeter are allowed. |
| core.List<core.String>? resources; |
| |
| /// IAM roles that represent the set of operations that the sources specified |
| /// in the corresponding IngressFrom are allowed to perform in this |
| /// ServicePerimeter. |
| core.List<core.String>? roles; |
| |
| IngressTo({this.operations, this.resources, this.roles}); |
| |
| IngressTo.fromJson(core.Map json_) |
| : this( |
| operations: (json_['operations'] as core.List?) |
| ?.map( |
| (value) => ApiOperation.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| resources: (json_['resources'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| roles: (json_['roles'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final operations = this.operations; |
| final resources = this.resources; |
| final roles = this.roles; |
| return { |
| 'operations': ?operations, |
| 'resources': ?resources, |
| 'roles': ?roles, |
| }; |
| } |
| } |
| |
| /// A response to `ListAccessLevelsRequest`. |
| class ListAccessLevelsResponse { |
| /// List of the Access Level instances. |
| core.List<AccessLevel>? accessLevels; |
| |
| /// The pagination token to retrieve the next page of results. |
| /// |
| /// If the value is empty, no further results remain. |
| core.String? nextPageToken; |
| |
| ListAccessLevelsResponse({this.accessLevels, this.nextPageToken}); |
| |
| ListAccessLevelsResponse.fromJson(core.Map json_) |
| : this( |
| accessLevels: (json_['accessLevels'] as core.List?) |
| ?.map( |
| (value) => AccessLevel.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final accessLevels = this.accessLevels; |
| final nextPageToken = this.nextPageToken; |
| return {'accessLevels': ?accessLevels, 'nextPageToken': ?nextPageToken}; |
| } |
| } |
| |
| /// A response to `ListAccessPoliciesRequest`. |
| class ListAccessPoliciesResponse { |
| /// List of the AccessPolicy instances. |
| core.List<AccessPolicy>? accessPolicies; |
| |
| /// The pagination token to retrieve the next page of results. |
| /// |
| /// If the value is empty, no further results remain. |
| core.String? nextPageToken; |
| |
| ListAccessPoliciesResponse({this.accessPolicies, this.nextPageToken}); |
| |
| ListAccessPoliciesResponse.fromJson(core.Map json_) |
| : this( |
| accessPolicies: (json_['accessPolicies'] as core.List?) |
| ?.map( |
| (value) => AccessPolicy.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final accessPolicies = this.accessPolicies; |
| final nextPageToken = this.nextPageToken; |
| return {'accessPolicies': ?accessPolicies, 'nextPageToken': ?nextPageToken}; |
| } |
| } |
| |
| /// A response to `ListAuthorizedOrgsDescsRequest`. |
| class ListAuthorizedOrgsDescsResponse { |
| /// List of all the Authorized Orgs Desc instances. |
| core.List<AuthorizedOrgsDesc>? authorizedOrgsDescs; |
| |
| /// The pagination token to retrieve the next page of results. |
| /// |
| /// If the value is empty, no further results remain. |
| core.String? nextPageToken; |
| |
| ListAuthorizedOrgsDescsResponse({ |
| this.authorizedOrgsDescs, |
| this.nextPageToken, |
| }); |
| |
| ListAuthorizedOrgsDescsResponse.fromJson(core.Map json_) |
| : this( |
| authorizedOrgsDescs: (json_['authorizedOrgsDescs'] as core.List?) |
| ?.map( |
| (value) => AuthorizedOrgsDesc.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final authorizedOrgsDescs = this.authorizedOrgsDescs; |
| final nextPageToken = this.nextPageToken; |
| return { |
| 'authorizedOrgsDescs': ?authorizedOrgsDescs, |
| 'nextPageToken': ?nextPageToken, |
| }; |
| } |
| } |
| |
| /// Response of ListGcpUserAccessBindings. |
| class ListGcpUserAccessBindingsResponse { |
| /// GcpUserAccessBinding |
| core.List<GcpUserAccessBinding>? gcpUserAccessBindings; |
| |
| /// Token to get the next page of items. |
| /// |
| /// If blank, there are no more items. |
| core.String? nextPageToken; |
| |
| ListGcpUserAccessBindingsResponse({ |
| this.gcpUserAccessBindings, |
| this.nextPageToken, |
| }); |
| |
| ListGcpUserAccessBindingsResponse.fromJson(core.Map json_) |
| : this( |
| gcpUserAccessBindings: (json_['gcpUserAccessBindings'] as core.List?) |
| ?.map( |
| (value) => GcpUserAccessBinding.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final gcpUserAccessBindings = this.gcpUserAccessBindings; |
| final nextPageToken = this.nextPageToken; |
| return { |
| 'gcpUserAccessBindings': ?gcpUserAccessBindings, |
| 'nextPageToken': ?nextPageToken, |
| }; |
| } |
| } |
| |
| /// The response message for Operations.ListOperations. |
| class ListOperationsResponse { |
| /// The standard List next-page token. |
| core.String? nextPageToken; |
| |
| /// A list of operations that matches the specified filter in the request. |
| core.List<Operation>? 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; |
| |
| ListOperationsResponse({ |
| this.nextPageToken, |
| this.operations, |
| this.unreachable, |
| }); |
| |
| ListOperationsResponse.fromJson(core.Map json_) |
| : this( |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| operations: (json_['operations'] as core.List?) |
| ?.map( |
| (value) => Operation.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, |
| }; |
| } |
| } |
| |
| /// A response to `ListServicePerimetersRequest`. |
| class ListServicePerimetersResponse { |
| /// The pagination token to retrieve the next page of results. |
| /// |
| /// If the value is empty, no further results remain. |
| core.String? nextPageToken; |
| |
| /// List of the Service Perimeter instances. |
| core.List<ServicePerimeter>? servicePerimeters; |
| |
| ListServicePerimetersResponse({this.nextPageToken, this.servicePerimeters}); |
| |
| ListServicePerimetersResponse.fromJson(core.Map json_) |
| : this( |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| servicePerimeters: (json_['servicePerimeters'] as core.List?) |
| ?.map( |
| (value) => ServicePerimeter.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final nextPageToken = this.nextPageToken; |
| final servicePerimeters = this.servicePerimeters; |
| return { |
| 'nextPageToken': ?nextPageToken, |
| 'servicePerimeters': ?servicePerimeters, |
| }; |
| } |
| } |
| |
| /// A response to `ListSupportedServicesRequest`. |
| class ListSupportedServicesResponse { |
| /// The pagination token to retrieve the next page of results. |
| /// |
| /// If the value is empty, no further results remain. |
| core.String? nextPageToken; |
| |
| /// List of services supported by VPC Service Controls instances. |
| core.List<SupportedService>? supportedServices; |
| |
| ListSupportedServicesResponse({this.nextPageToken, this.supportedServices}); |
| |
| ListSupportedServicesResponse.fromJson(core.Map json_) |
| : this( |
| nextPageToken: json_['nextPageToken'] as core.String?, |
| supportedServices: (json_['supportedServices'] as core.List?) |
| ?.map( |
| (value) => SupportedService.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final nextPageToken = this.nextPageToken; |
| final supportedServices = this.supportedServices; |
| return { |
| 'nextPageToken': ?nextPageToken, |
| 'supportedServices': ?supportedServices, |
| }; |
| } |
| } |
| |
| /// An allowed method or permission of a service specified in ApiOperation. |
| typedef MethodSelector = $MethodSelector; |
| |
| /// This resource represents a long-running operation that is the result of a |
| /// network API call. |
| class Operation { |
| /// 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. |
| Status? 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; |
| |
| Operation({this.done, this.error, this.metadata, this.name, this.response}); |
| |
| Operation.fromJson(core.Map json_) |
| : this( |
| done: json_['done'] as core.bool?, |
| error: json_.containsKey('error') |
| ? Status.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, |
| }; |
| } |
| } |
| |
| /// A restriction on the OS type and version of devices making requests. |
| typedef OsConstraint = $OsConstraint; |
| |
| /// 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 Policy { |
| /// Specifies cloud audit logging configuration for this policy. |
| core.List<AuditConfig>? 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<Binding>? 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; |
| |
| Policy({this.auditConfigs, this.bindings, this.etag, this.version}); |
| |
| Policy.fromJson(core.Map json_) |
| : this( |
| auditConfigs: (json_['auditConfigs'] as core.List?) |
| ?.map( |
| (value) => AuditConfig.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| bindings: (json_['bindings'] as core.List?) |
| ?.map( |
| (value) => Binding.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, |
| }; |
| } |
| } |
| |
| /// A request to replace all existing Access Levels in an Access Policy with the |
| /// Access Levels provided. |
| /// |
| /// This is done atomically. |
| class ReplaceAccessLevelsRequest { |
| /// The desired Access Levels that should replace all existing Access Levels |
| /// in the Access Policy. |
| /// |
| /// Required. |
| core.List<AccessLevel>? accessLevels; |
| |
| /// The etag for the version of the Access Policy that this replace operation |
| /// is to be performed on. |
| /// |
| /// If, at the time of replace, the etag for the Access Policy stored in |
| /// Access Context Manager is different from the specified etag, then the |
| /// replace operation will not be performed and the call will fail. This field |
| /// is not required. If etag is not provided, the operation will be performed |
| /// as if a valid etag is provided. |
| /// |
| /// Optional. |
| core.String? etag; |
| |
| ReplaceAccessLevelsRequest({this.accessLevels, this.etag}); |
| |
| ReplaceAccessLevelsRequest.fromJson(core.Map json_) |
| : this( |
| accessLevels: (json_['accessLevels'] as core.List?) |
| ?.map( |
| (value) => AccessLevel.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| etag: json_['etag'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final accessLevels = this.accessLevels; |
| final etag = this.etag; |
| return {'accessLevels': ?accessLevels, 'etag': ?etag}; |
| } |
| } |
| |
| /// A request to replace all existing Service Perimeters in an Access Policy |
| /// with the Service Perimeters provided. |
| /// |
| /// This is done atomically. |
| class ReplaceServicePerimetersRequest { |
| /// The etag for the version of the Access Policy that this replace operation |
| /// is to be performed on. |
| /// |
| /// If, at the time of replace, the etag for the Access Policy stored in |
| /// Access Context Manager is different from the specified etag, then the |
| /// replace operation will not be performed and the call will fail. This field |
| /// is not required. If etag is not provided, the operation will be performed |
| /// as if a valid etag is provided. |
| /// |
| /// Optional. |
| core.String? etag; |
| |
| /// The desired Service Perimeters that should replace all existing Service |
| /// Perimeters in the Access Policy. |
| /// |
| /// Required. |
| core.List<ServicePerimeter>? servicePerimeters; |
| |
| ReplaceServicePerimetersRequest({this.etag, this.servicePerimeters}); |
| |
| ReplaceServicePerimetersRequest.fromJson(core.Map json_) |
| : this( |
| etag: json_['etag'] as core.String?, |
| servicePerimeters: (json_['servicePerimeters'] as core.List?) |
| ?.map( |
| (value) => ServicePerimeter.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final etag = this.etag; |
| final servicePerimeters = this.servicePerimeters; |
| return {'etag': ?etag, 'servicePerimeters': ?servicePerimeters}; |
| } |
| } |
| |
| /// A relationship between access settings and its scope. |
| class ScopedAccessSettings { |
| /// Access settings for this scoped access settings. |
| /// |
| /// This field may be empty if dry_run_settings is set. |
| /// |
| /// Optional. |
| AccessSettings? activeSettings; |
| |
| /// Dry-run access settings for this scoped access settings. |
| /// |
| /// This field may be empty if active_settings is set. |
| /// |
| /// Optional. |
| AccessSettings? dryRunSettings; |
| |
| /// Application, etc. |
| /// |
| /// to which the access settings will be applied to. Implicitly, this is the |
| /// scoped access settings key; as such, it must be unique and non-empty. |
| /// |
| /// Optional. |
| AccessScope? scope; |
| |
| ScopedAccessSettings({this.activeSettings, this.dryRunSettings, this.scope}); |
| |
| ScopedAccessSettings.fromJson(core.Map json_) |
| : this( |
| activeSettings: json_.containsKey('activeSettings') |
| ? AccessSettings.fromJson( |
| json_['activeSettings'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| dryRunSettings: json_.containsKey('dryRunSettings') |
| ? AccessSettings.fromJson( |
| json_['dryRunSettings'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| scope: json_.containsKey('scope') |
| ? AccessScope.fromJson( |
| json_['scope'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final activeSettings = this.activeSettings; |
| final dryRunSettings = this.dryRunSettings; |
| final scope = this.scope; |
| return { |
| 'activeSettings': ?activeSettings, |
| 'dryRunSettings': ?dryRunSettings, |
| 'scope': ?scope, |
| }; |
| } |
| } |
| |
| /// `ServicePerimeter` describes a set of Google Cloud resources which can |
| /// freely import and export data amongst themselves, but not export outside of |
| /// the `ServicePerimeter`. |
| /// |
| /// If a request with a source within this `ServicePerimeter` has a target |
| /// outside of the `ServicePerimeter`, the request will be blocked. Otherwise |
| /// the request is allowed. There are two types of Service Perimeter - Regular |
| /// and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud |
| /// project or VPC network can only belong to a single regular Service |
| /// Perimeter. Service Perimeter Bridges can contain only Google Cloud projects |
| /// as members, a single Google Cloud project may belong to multiple Service |
| /// Perimeter Bridges. |
| class ServicePerimeter { |
| /// Description of the `ServicePerimeter` and its use. |
| /// |
| /// Does not affect behavior. |
| core.String? description; |
| |
| /// An opaque identifier for the current version of the `ServicePerimeter`. |
| /// |
| /// This identifier does not follow any specific format. If an etag is not |
| /// provided, the operation will be performed as if a valid etag is provided. |
| /// |
| /// Optional. |
| core.String? etag; |
| |
| /// Identifier. |
| /// |
| /// Resource name for the `ServicePerimeter`. Format: |
| /// `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`. |
| /// The `service_perimeter` component must begin with a letter, followed by |
| /// alphanumeric characters or `_`. After you create a `ServicePerimeter`, you |
| /// cannot change its `name`. |
| core.String? name; |
| |
| /// Perimeter type indicator. |
| /// |
| /// A single project or VPC network is allowed to be a member of single |
| /// regular perimeter, but multiple service perimeter bridges. A project |
| /// cannot be a included in a perimeter bridge without being included in |
| /// regular perimeter. For perimeter bridges, the restricted service list as |
| /// well as access level lists must be empty. |
| /// Possible string values are: |
| /// - "PERIMETER_TYPE_REGULAR" : Regular Perimeter. When no value is |
| /// specified, the perimeter uses this type. |
| /// - "PERIMETER_TYPE_BRIDGE" : Perimeter Bridge. |
| core.String? perimeterType; |
| |
| /// Proposed (or dry run) ServicePerimeter configuration. |
| /// |
| /// This configuration allows to specify and test ServicePerimeter |
| /// configuration without enforcing actual access restrictions. Only allowed |
| /// to be set when the "use_explicit_dry_run_spec" flag is set. |
| ServicePerimeterConfig? spec; |
| |
| /// Current ServicePerimeter configuration. |
| /// |
| /// Specifies sets of resources, restricted services and access levels that |
| /// determine perimeter content and boundaries. |
| ServicePerimeterConfig? status; |
| |
| /// Human readable title. |
| /// |
| /// Must be unique within the Policy. |
| core.String? title; |
| |
| /// Use explicit dry run spec flag. |
| /// |
| /// Ordinarily, a dry-run spec implicitly exists for all Service Perimeters, |
| /// and that spec is identical to the status for those Service Perimeters. |
| /// When this flag is set, it inhibits the generation of the implicit spec, |
| /// thereby allowing the user to explicitly provide a configuration ("spec") |
| /// to use in a dry-run version of the Service Perimeter. This allows the user |
| /// to test changes to the enforced config ("status") without actually |
| /// enforcing them. This testing is done through analyzing the differences |
| /// between currently enforced and suggested restrictions. |
| /// use_explicit_dry_run_spec must bet set to True if any of the fields in the |
| /// spec are set to non-default values. |
| core.bool? useExplicitDryRunSpec; |
| |
| ServicePerimeter({ |
| this.description, |
| this.etag, |
| this.name, |
| this.perimeterType, |
| this.spec, |
| this.status, |
| this.title, |
| this.useExplicitDryRunSpec, |
| }); |
| |
| ServicePerimeter.fromJson(core.Map json_) |
| : this( |
| description: json_['description'] as core.String?, |
| etag: json_['etag'] as core.String?, |
| name: json_['name'] as core.String?, |
| perimeterType: json_['perimeterType'] as core.String?, |
| spec: json_.containsKey('spec') |
| ? ServicePerimeterConfig.fromJson( |
| json_['spec'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| status: json_.containsKey('status') |
| ? ServicePerimeterConfig.fromJson( |
| json_['status'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| title: json_['title'] as core.String?, |
| useExplicitDryRunSpec: json_['useExplicitDryRunSpec'] as core.bool?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final description = this.description; |
| final etag = this.etag; |
| final name = this.name; |
| final perimeterType = this.perimeterType; |
| final spec = this.spec; |
| final status = this.status; |
| final title = this.title; |
| final useExplicitDryRunSpec = this.useExplicitDryRunSpec; |
| return { |
| 'description': ?description, |
| 'etag': ?etag, |
| 'name': ?name, |
| 'perimeterType': ?perimeterType, |
| 'spec': ?spec, |
| 'status': ?status, |
| 'title': ?title, |
| 'useExplicitDryRunSpec': ?useExplicitDryRunSpec, |
| }; |
| } |
| } |
| |
| /// `ServicePerimeterConfig` specifies a set of Google Cloud resources that |
| /// describe specific Service Perimeter configuration. |
| class ServicePerimeterConfig { |
| /// A list of `AccessLevel` resource names that allow resources within the |
| /// `ServicePerimeter` to be accessed from the internet. |
| /// |
| /// `AccessLevels` listed must be in the same policy as this |
| /// `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax |
| /// error. If no `AccessLevel` names are listed, resources within the |
| /// perimeter can only be accessed via Google Cloud calls with request origins |
| /// within the perimeter. Example: |
| /// `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter |
| /// Bridge, must be empty. |
| core.List<core.String>? accessLevels; |
| |
| /// List of EgressPolicies to apply to the perimeter. |
| /// |
| /// A perimeter may have multiple EgressPolicies, each of which is evaluated |
| /// separately. Access is granted if any EgressPolicy grants it. Must be empty |
| /// for a perimeter bridge. |
| core.List<EgressPolicy>? egressPolicies; |
| |
| /// List of IngressPolicies to apply to the perimeter. |
| /// |
| /// A perimeter may have multiple IngressPolicies, each of which is evaluated |
| /// separately. Access is granted if any Ingress Policy grants it. Must be |
| /// empty for a perimeter bridge. |
| core.List<IngressPolicy>? ingressPolicies; |
| |
| /// A list of Google Cloud resources that are inside of the service perimeter. |
| /// |
| /// Currently only projects and VPCs are allowed. Project format: |
| /// `projects/{project_number}` VPC network format: |
| /// `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. |
| core.List<core.String>? resources; |
| |
| /// Google Cloud services that are subject to the Service Perimeter |
| /// restrictions. |
| /// |
| /// For example, if `storage.googleapis.com` is specified, access to the |
| /// storage buckets inside the perimeter must meet the perimeter's access |
| /// restrictions. |
| core.List<core.String>? restrictedServices; |
| |
| /// Configuration for APIs allowed within Perimeter. |
| VpcAccessibleServices? vpcAccessibleServices; |
| |
| ServicePerimeterConfig({ |
| this.accessLevels, |
| this.egressPolicies, |
| this.ingressPolicies, |
| this.resources, |
| this.restrictedServices, |
| this.vpcAccessibleServices, |
| }); |
| |
| ServicePerimeterConfig.fromJson(core.Map json_) |
| : this( |
| accessLevels: (json_['accessLevels'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| egressPolicies: (json_['egressPolicies'] as core.List?) |
| ?.map( |
| (value) => EgressPolicy.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| ingressPolicies: (json_['ingressPolicies'] as core.List?) |
| ?.map( |
| (value) => IngressPolicy.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| resources: (json_['resources'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| restrictedServices: (json_['restrictedServices'] as core.List?) |
| ?.map((value) => value as core.String) |
| .toList(), |
| vpcAccessibleServices: json_.containsKey('vpcAccessibleServices') |
| ? VpcAccessibleServices.fromJson( |
| json_['vpcAccessibleServices'] |
| as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final accessLevels = this.accessLevels; |
| final egressPolicies = this.egressPolicies; |
| final ingressPolicies = this.ingressPolicies; |
| final resources = this.resources; |
| final restrictedServices = this.restrictedServices; |
| final vpcAccessibleServices = this.vpcAccessibleServices; |
| return { |
| 'accessLevels': ?accessLevels, |
| 'egressPolicies': ?egressPolicies, |
| 'ingressPolicies': ?ingressPolicies, |
| 'resources': ?resources, |
| 'restrictedServices': ?restrictedServices, |
| 'vpcAccessibleServices': ?vpcAccessibleServices, |
| }; |
| } |
| } |
| |
| /// Stores settings related to Google Cloud Session Length including session |
| /// duration, the type of challenge (i.e. method) they should face when their |
| /// session expires, and other related settings. |
| class SessionSettings { |
| /// How long a user is allowed to take between actions before a new access |
| /// token must be issued. |
| /// |
| /// Only set for Google Cloud apps. |
| /// |
| /// Optional. |
| core.String? maxInactivity; |
| |
| /// The session length. |
| /// |
| /// Setting this field to zero is equal to disabling session. Also can set |
| /// infinite session by flipping the enabled bit to false below. If |
| /// use_oidc_max_age is true, for OIDC apps, the session length will be the |
| /// minimum of this field and OIDC max_age param. |
| /// |
| /// Optional. |
| core.String? sessionLength; |
| |
| /// This field enables or disables Google Cloud session length. |
| /// |
| /// When false, all fields set above will be disregarded and the session |
| /// length is basically infinite. |
| /// |
| /// Optional. |
| core.bool? sessionLengthEnabled; |
| |
| /// Session method when user's Google Cloud session is up. |
| /// |
| /// Optional. |
| /// Possible string values are: |
| /// - "SESSION_REAUTH_METHOD_UNSPECIFIED" : If method is undefined in the API, |
| /// LOGIN will be used by default. |
| /// - "LOGIN" : The user will be prompted to perform regular login. Users who |
| /// are enrolled for two-step verification and haven't chosen "Remember this |
| /// computer" will be prompted for their second factor. |
| /// - "SECURITY_KEY" : The user will be prompted to authenticate using their |
| /// security key. If no security key has been configured, then authentication |
| /// will fallback to LOGIN. |
| /// - "PASSWORD" : The user will be prompted for their password. |
| core.String? sessionReauthMethod; |
| |
| /// Only useful for OIDC apps. |
| /// |
| /// When false, the OIDC max_age param, if passed in the authentication |
| /// request will be ignored. When true, the re-auth period will be the minimum |
| /// of the session_length field and the max_age OIDC param. |
| /// |
| /// Optional. |
| core.bool? useOidcMaxAge; |
| |
| SessionSettings({ |
| this.maxInactivity, |
| this.sessionLength, |
| this.sessionLengthEnabled, |
| this.sessionReauthMethod, |
| this.useOidcMaxAge, |
| }); |
| |
| SessionSettings.fromJson(core.Map json_) |
| : this( |
| maxInactivity: json_['maxInactivity'] as core.String?, |
| sessionLength: json_['sessionLength'] as core.String?, |
| sessionLengthEnabled: json_['sessionLengthEnabled'] as core.bool?, |
| sessionReauthMethod: json_['sessionReauthMethod'] as core.String?, |
| useOidcMaxAge: json_['useOidcMaxAge'] as core.bool?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final maxInactivity = this.maxInactivity; |
| final sessionLength = this.sessionLength; |
| final sessionLengthEnabled = this.sessionLengthEnabled; |
| final sessionReauthMethod = this.sessionReauthMethod; |
| final useOidcMaxAge = this.useOidcMaxAge; |
| return { |
| 'maxInactivity': ?maxInactivity, |
| 'sessionLength': ?sessionLength, |
| 'sessionLengthEnabled': ?sessionLengthEnabled, |
| 'sessionReauthMethod': ?sessionReauthMethod, |
| 'useOidcMaxAge': ?useOidcMaxAge, |
| }; |
| } |
| } |
| |
| /// Request message for `SetIamPolicy` method. |
| class SetIamPolicyRequest { |
| /// REQUIRED: The complete policy to be applied to the `resource`. |
| /// |
| /// The size of the policy is limited to a few 10s of KB. An empty policy is a |
| /// valid policy but certain Google Cloud services (such as Projects) might |
| /// reject them. |
| Policy? policy; |
| |
| /// OPTIONAL: A FieldMask specifying which fields of the policy to modify. |
| /// |
| /// Only the fields in the mask will be modified. If no mask is provided, the |
| /// following default mask is used: `paths: "bindings, etag"` |
| core.String? updateMask; |
| |
| SetIamPolicyRequest({this.policy, this.updateMask}); |
| |
| SetIamPolicyRequest.fromJson(core.Map json_) |
| : this( |
| policy: json_.containsKey('policy') |
| ? Policy.fromJson( |
| json_['policy'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| updateMask: json_['updateMask'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final policy = this.policy; |
| final updateMask = this.updateMask; |
| return {'policy': ?policy, 'updateMask': ?updateMask}; |
| } |
| } |
| |
| /// 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 Status = $Status00; |
| |
| /// `SupportedService` specifies the VPC Service Controls and its properties. |
| class SupportedService { |
| /// True if the service is available on the restricted VIP. |
| /// |
| /// Services on the restricted VIP typically either support VPC Service |
| /// Controls or are core infrastructure services required for the functioning |
| /// of Google Cloud. |
| core.bool? availableOnRestrictedVip; |
| |
| /// True if the service is supported with some limitations. |
| /// |
| /// Check |
| /// [documentation](https://cloud.google.com/vpc-service-controls/docs/supported-products) |
| /// for details. |
| core.bool? knownLimitations; |
| |
| /// The service name or address of the supported service, such as |
| /// `service.googleapis.com`. |
| core.String? name; |
| |
| /// The support stage of the service. |
| /// Possible string values are: |
| /// - "SERVICE_SUPPORT_STAGE_UNSPECIFIED" : Do not use this default value. |
| /// - "GA" : GA features are open to all developers and are considered stable |
| /// and fully qualified for production use. |
| /// - "PREVIEW" : PREVIEW indicates a pre-release stage where the product is |
| /// functionally complete but undergoing real-world testing. |
| /// - "DEPRECATED" : Deprecated features are scheduled to be shut down and |
| /// removed. |
| core.String? serviceSupportStage; |
| |
| /// The support stage of the service. |
| /// Possible string values are: |
| /// - "LAUNCH_STAGE_UNSPECIFIED" : Do not use this default value. |
| /// - "UNIMPLEMENTED" : The feature is not yet implemented. Users can not use |
| /// it. |
| /// - "PRELAUNCH" : Prelaunch features are hidden from users and are only |
| /// visible internally. |
| /// - "EARLY_ACCESS" : Early Access features are limited to a closed group of |
| /// testers. To use these features, you must sign up in advance and sign a |
| /// Trusted Tester agreement (which includes confidentiality provisions). |
| /// These features may be unstable, changed in backward-incompatible ways, and |
| /// are not guaranteed to be released. |
| /// - "ALPHA" : Alpha is a limited availability test for releases before they |
| /// are cleared for widespread use. By Alpha, all significant design issues |
| /// are resolved and we are in the process of verifying functionality. Alpha |
| /// customers need to apply for access, agree to applicable terms, and have |
| /// their projects allowlisted. Alpha releases don't have to be feature |
| /// complete, no SLAs are provided, and there are no technical support |
| /// obligations, but they will be far enough along that customers can actually |
| /// use them in test environments or for limited-use tests -- just like they |
| /// would in normal production cases. |
| /// - "BETA" : Beta is the point at which we are ready to open a release for |
| /// any customer to use. There are no SLA or technical support obligations in |
| /// a Beta release. Products will be complete from a feature perspective, but |
| /// may have some open outstanding issues. Beta releases are suitable for |
| /// limited production use cases. |
| /// - "GA" : GA features are open to all developers and are considered stable |
| /// and fully qualified for production use. |
| /// - "DEPRECATED" : Deprecated features are scheduled to be shut down and |
| /// removed. For more information, see the "Deprecation Policy" section of our |
| /// [Terms of Service](https://cloud.google.com/terms/) and the |
| /// [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) |
| /// documentation. |
| core.String? supportStage; |
| |
| /// The list of the supported methods. |
| /// |
| /// This field exists only in response to GetSupportedService |
| core.List<MethodSelector>? supportedMethods; |
| |
| /// The name of the supported product, such as 'Cloud Product API'. |
| core.String? title; |
| |
| SupportedService({ |
| this.availableOnRestrictedVip, |
| this.knownLimitations, |
| this.name, |
| this.serviceSupportStage, |
| this.supportStage, |
| this.supportedMethods, |
| this.title, |
| }); |
| |
| SupportedService.fromJson(core.Map json_) |
| : this( |
| availableOnRestrictedVip: |
| json_['availableOnRestrictedVip'] as core.bool?, |
| knownLimitations: json_['knownLimitations'] as core.bool?, |
| name: json_['name'] as core.String?, |
| serviceSupportStage: json_['serviceSupportStage'] as core.String?, |
| supportStage: json_['supportStage'] as core.String?, |
| supportedMethods: (json_['supportedMethods'] as core.List?) |
| ?.map( |
| (value) => MethodSelector.fromJson( |
| value as core.Map<core.String, core.dynamic>, |
| ), |
| ) |
| .toList(), |
| title: json_['title'] as core.String?, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final availableOnRestrictedVip = this.availableOnRestrictedVip; |
| final knownLimitations = this.knownLimitations; |
| final name = this.name; |
| final serviceSupportStage = this.serviceSupportStage; |
| final supportStage = this.supportStage; |
| final supportedMethods = this.supportedMethods; |
| final title = this.title; |
| return { |
| 'availableOnRestrictedVip': ?availableOnRestrictedVip, |
| 'knownLimitations': ?knownLimitations, |
| 'name': ?name, |
| 'serviceSupportStage': ?serviceSupportStage, |
| 'supportStage': ?supportStage, |
| 'supportedMethods': ?supportedMethods, |
| 'title': ?title, |
| }; |
| } |
| } |
| |
| /// Request message for `TestIamPermissions` method. |
| typedef TestIamPermissionsRequest = $TestIamPermissionsRequest00; |
| |
| /// Response message for `TestIamPermissions` method. |
| typedef TestIamPermissionsResponse = $PermissionsResponse; |
| |
| /// Specifies how APIs are allowed to communicate within the Service Perimeter. |
| typedef VpcAccessibleServices = $VpcAccessibleServices; |
| |
| /// The originating network source in Google Cloud. |
| class VpcNetworkSource { |
| /// Sub-segment ranges of a VPC network. |
| VpcSubNetwork? vpcSubnetwork; |
| |
| VpcNetworkSource({this.vpcSubnetwork}); |
| |
| VpcNetworkSource.fromJson(core.Map json_) |
| : this( |
| vpcSubnetwork: json_.containsKey('vpcSubnetwork') |
| ? VpcSubNetwork.fromJson( |
| json_['vpcSubnetwork'] as core.Map<core.String, core.dynamic>, |
| ) |
| : null, |
| ); |
| |
| core.Map<core.String, core.dynamic> toJson() { |
| final vpcSubnetwork = this.vpcSubnetwork; |
| return {'vpcSubnetwork': ?vpcSubnetwork}; |
| } |
| } |
| |
| /// Sub-segment ranges inside of a VPC Network. |
| typedef VpcSubNetwork = $VpcSubNetwork; |