google-api-ruby-client/generated/google/apis/accesscontextmanager_v1/classes.rb

991 lines
43 KiB
Ruby

# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module AccesscontextmanagerV1
# 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
include Google::Apis::Core::Hashable
# `BasicLevel` is an `AccessLevel` using a set of recommended features.
# Corresponds to the JSON property `basic`
# @return [Google::Apis::AccesscontextmanagerV1::BasicLevel]
attr_accessor :basic
# `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
# Corresponds to the JSON property `custom`
# @return [Google::Apis::AccesscontextmanagerV1::CustomLevel]
attr_accessor :custom
# Description of the `AccessLevel` and its use. Does not affect behavior.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Required. Resource name for the Access Level. The `short_name` component
# must begin with a letter and only include alphanumeric and '_'. Format:
# `accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length
# of the `short_name` component is 50 characters.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Human readable title. Must be unique within the Policy.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@basic = args[:basic] if args.key?(:basic)
@custom = args[:custom] if args.key?(:custom)
@description = args[:description] if args.key?(:description)
@name = args[:name] if args.key?(:name)
@title = args[:title] if args.key?(:title)
end
end
# `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.
class AccessPolicy
include Google::Apis::Core::Hashable
# Output only. An opaque identifier for the current version of the
# `AccessPolicy`. This will always be a strongly validated etag, meaning that
# two Access Polices will be identical if and only if their etags are
# identical. Clients should not expect this to be in any specific format.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# Output only. Resource name of the `AccessPolicy`. Format:
# `accessPolicies/`policy_id``
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Required. The parent of this `AccessPolicy` in the Cloud Resource
# Hierarchy. Currently immutable once created. Format:
# `organizations/`organization_id``
# Corresponds to the JSON property `parent`
# @return [String]
attr_accessor :parent
# Required. Human readable title. Does not affect behavior.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
@name = args[:name] if args.key?(:name)
@parent = args[:parent] if args.key?(:parent)
@title = args[:title] if args.key?(:title)
end
end
# `BasicLevel` is an `AccessLevel` using a set of recommended features.
class BasicLevel
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `combiningFunction`
# @return [String]
attr_accessor :combining_function
# Required. A list of requirements for the `AccessLevel` to be granted.
# Corresponds to the JSON property `conditions`
# @return [Array<Google::Apis::AccesscontextmanagerV1::Condition>]
attr_accessor :conditions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@combining_function = args[:combining_function] if args.key?(:combining_function)
@conditions = args[:conditions] if args.key?(:conditions)
end
end
# The request message for Operations.CancelOperation.
class CancelOperationRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# A request to commit dry-run specs in all Service Perimeters belonging to
# an Access Policy.
class CommitServicePerimetersRequest
include Google::Apis::Core::Hashable
# Optional. 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.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
end
end
# A response to CommitServicePerimetersRequest. This will be put inside of
# Operation.response field.
class CommitServicePerimetersResponse
include Google::Apis::Core::Hashable
# List of all the Service Perimeter instances in
# the Access Policy.
# Corresponds to the JSON property `servicePerimeters`
# @return [Array<Google::Apis::AccesscontextmanagerV1::ServicePerimeter>]
attr_accessor :service_perimeters
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@service_perimeters = args[:service_perimeters] if args.key?(:service_perimeters)
end
end
# 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
include Google::Apis::Core::Hashable
# `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.
# Corresponds to the JSON property `devicePolicy`
# @return [Google::Apis::AccesscontextmanagerV1::DevicePolicy]
attr_accessor :device_policy
# 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.
# Corresponds to the JSON property `ipSubnetworks`
# @return [Array<String>]
attr_accessor :ip_subnetworks
# 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.
# Corresponds to the JSON property `members`
# @return [Array<String>]
attr_accessor :members
# Whether to negate the Condition. If true, the Condition becomes a NAND over
# its non-empty fields, each field must be false for the Condition overall to
# be satisfied. Defaults to false.
# Corresponds to the JSON property `negate`
# @return [Boolean]
attr_accessor :negate
alias_method :negate?, :negate
# The request must originate from one of the provided countries/regions.
# Must be valid ISO 3166-1 alpha-2 codes.
# Corresponds to the JSON property `regions`
# @return [Array<String>]
attr_accessor :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"`
# Corresponds to the JSON property `requiredAccessLevels`
# @return [Array<String>]
attr_accessor :required_access_levels
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@device_policy = args[:device_policy] if args.key?(:device_policy)
@ip_subnetworks = args[:ip_subnetworks] if args.key?(:ip_subnetworks)
@members = args[:members] if args.key?(:members)
@negate = args[:negate] if args.key?(:negate)
@regions = args[:regions] if args.key?(:regions)
@required_access_levels = args[:required_access_levels] if args.key?(:required_access_levels)
end
end
# `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
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `expr`
# @return [Google::Apis::AccesscontextmanagerV1::Expr]
attr_accessor :expr
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@expr = args[:expr] if args.key?(:expr)
end
end
# `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
include Google::Apis::Core::Hashable
# Allowed device management levels, an empty list allows all management
# levels.
# Corresponds to the JSON property `allowedDeviceManagementLevels`
# @return [Array<String>]
attr_accessor :allowed_device_management_levels
# Allowed encryptions statuses, an empty list allows all statuses.
# Corresponds to the JSON property `allowedEncryptionStatuses`
# @return [Array<String>]
attr_accessor :allowed_encryption_statuses
# Allowed OS versions, an empty list allows all types and all versions.
# Corresponds to the JSON property `osConstraints`
# @return [Array<Google::Apis::AccesscontextmanagerV1::OsConstraint>]
attr_accessor :os_constraints
# Whether the device needs to be approved by the customer admin.
# Corresponds to the JSON property `requireAdminApproval`
# @return [Boolean]
attr_accessor :require_admin_approval
alias_method :require_admin_approval?, :require_admin_approval
# Whether the device needs to be corp owned.
# Corresponds to the JSON property `requireCorpOwned`
# @return [Boolean]
attr_accessor :require_corp_owned
alias_method :require_corp_owned?, :require_corp_owned
# Whether or not screenlock is required for the DevicePolicy to be true.
# Defaults to `false`.
# Corresponds to the JSON property `requireScreenlock`
# @return [Boolean]
attr_accessor :require_screenlock
alias_method :require_screenlock?, :require_screenlock
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allowed_device_management_levels = args[:allowed_device_management_levels] if args.key?(:allowed_device_management_levels)
@allowed_encryption_statuses = args[:allowed_encryption_statuses] if args.key?(:allowed_encryption_statuses)
@os_constraints = args[:os_constraints] if args.key?(:os_constraints)
@require_admin_approval = args[:require_admin_approval] if args.key?(:require_admin_approval)
@require_corp_owned = args[:require_corp_owned] if args.key?(:require_corp_owned)
@require_screenlock = args[:require_screenlock] if args.key?(:require_screenlock)
end
end
# 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);
# `
# The JSON representation for `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# 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.
class Expr
include Google::Apis::Core::Hashable
# Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Textual representation of an expression in Common Expression Language
# syntax.
# Corresponds to the JSON property `expression`
# @return [String]
attr_accessor :expression
# Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@expression = args[:expression] if args.key?(:expression)
@location = args[:location] if args.key?(:location)
@title = args[:title] if args.key?(:title)
end
end
# A response to `ListAccessLevelsRequest`.
class ListAccessLevelsResponse
include Google::Apis::Core::Hashable
# List of the Access Level instances.
# Corresponds to the JSON property `accessLevels`
# @return [Array<Google::Apis::AccesscontextmanagerV1::AccessLevel>]
attr_accessor :access_levels
# The pagination token to retrieve the next page of results. If the value is
# empty, no further results remain.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@access_levels = args[:access_levels] if args.key?(:access_levels)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# A response to `ListAccessPoliciesRequest`.
class ListAccessPoliciesResponse
include Google::Apis::Core::Hashable
# List of the AccessPolicy instances.
# Corresponds to the JSON property `accessPolicies`
# @return [Array<Google::Apis::AccesscontextmanagerV1::AccessPolicy>]
attr_accessor :access_policies
# The pagination token to retrieve the next page of results. If the value is
# empty, no further results remain.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@access_policies = args[:access_policies] if args.key?(:access_policies)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# The response message for Operations.ListOperations.
class ListOperationsResponse
include Google::Apis::Core::Hashable
# The standard List next-page token.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# A list of operations that matches the specified filter in the request.
# Corresponds to the JSON property `operations`
# @return [Array<Google::Apis::AccesscontextmanagerV1::Operation>]
attr_accessor :operations
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@operations = args[:operations] if args.key?(:operations)
end
end
# A response to `ListServicePerimetersRequest`.
class ListServicePerimetersResponse
include Google::Apis::Core::Hashable
# The pagination token to retrieve the next page of results. If the value is
# empty, no further results remain.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# List of the Service Perimeter instances.
# Corresponds to the JSON property `servicePerimeters`
# @return [Array<Google::Apis::AccesscontextmanagerV1::ServicePerimeter>]
attr_accessor :service_perimeters
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@service_perimeters = args[:service_perimeters] if args.key?(:service_perimeters)
end
end
# This resource represents a long-running operation that is the result of a
# network API call.
class Operation
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# 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).
# Corresponds to the JSON property `error`
# @return [Google::Apis::AccesscontextmanagerV1::Status]
attr_accessor :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.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :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``.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The normal response of the operation in case of success. 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`.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@done = args[:done] if args.key?(:done)
@error = args[:error] if args.key?(:error)
@metadata = args[:metadata] if args.key?(:metadata)
@name = args[:name] if args.key?(:name)
@response = args[:response] if args.key?(:response)
end
end
# A restriction on the OS type and version of devices making requests.
class OsConstraint
include Google::Apis::Core::Hashable
# The minimum allowed OS version. If not set, any version of this OS
# satisfies the constraint. Format: `"major.minor.patch"`.
# Examples: `"10.5.301"`, `"9.2.1"`.
# Corresponds to the JSON property `minimumVersion`
# @return [String]
attr_accessor :minimum_version
# Required. The allowed OS type.
# Corresponds to the JSON property `osType`
# @return [String]
attr_accessor :os_type
# Only allows requests from devices with a verified Chrome OS.
# Verifications includes requirements that the device is enterprise-managed,
# conformant to domain policies, and the caller has permission to call
# the API targeted by the request.
# Corresponds to the JSON property `requireVerifiedChromeOs`
# @return [Boolean]
attr_accessor :require_verified_chrome_os
alias_method :require_verified_chrome_os?, :require_verified_chrome_os
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@minimum_version = args[:minimum_version] if args.key?(:minimum_version)
@os_type = args[:os_type] if args.key?(:os_type)
@require_verified_chrome_os = args[:require_verified_chrome_os] if args.key?(:require_verified_chrome_os)
end
end
# A request to replace all existing Access Levels in an Access Policy with
# the Access Levels provided. This is done atomically.
class ReplaceAccessLevelsRequest
include Google::Apis::Core::Hashable
# Required. The desired Access Levels that should
# replace all existing Access Levels in the
# Access Policy.
# Corresponds to the JSON property `accessLevels`
# @return [Array<Google::Apis::AccesscontextmanagerV1::AccessLevel>]
attr_accessor :access_levels
# Optional. 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.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@access_levels = args[:access_levels] if args.key?(:access_levels)
@etag = args[:etag] if args.key?(:etag)
end
end
# A response to ReplaceAccessLevelsRequest. This will be put inside of
# Operation.response field.
class ReplaceAccessLevelsResponse
include Google::Apis::Core::Hashable
# List of the Access Level instances.
# Corresponds to the JSON property `accessLevels`
# @return [Array<Google::Apis::AccesscontextmanagerV1::AccessLevel>]
attr_accessor :access_levels
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@access_levels = args[:access_levels] if args.key?(:access_levels)
end
end
# A request to replace all existing Service Perimeters in an Access Policy
# with the Service Perimeters provided. This is done atomically.
class ReplaceServicePerimetersRequest
include Google::Apis::Core::Hashable
# Optional. 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.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# Required. The desired Service Perimeters that should
# replace all existing Service Perimeters in the
# Access Policy.
# Corresponds to the JSON property `servicePerimeters`
# @return [Array<Google::Apis::AccesscontextmanagerV1::ServicePerimeter>]
attr_accessor :service_perimeters
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
@service_perimeters = args[:service_perimeters] if args.key?(:service_perimeters)
end
end
# A response to ReplaceServicePerimetersRequest. This will be put inside of
# Operation.response field.
class ReplaceServicePerimetersResponse
include Google::Apis::Core::Hashable
# List of the Service Perimeter instances.
# Corresponds to the JSON property `servicePerimeters`
# @return [Array<Google::Apis::AccesscontextmanagerV1::ServicePerimeter>]
attr_accessor :service_perimeters
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@service_perimeters = args[:service_perimeters] if args.key?(:service_perimeters)
end
end
# `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 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
include Google::Apis::Core::Hashable
# Description of the `ServicePerimeter` and its use. Does not affect
# behavior.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Required. Resource name for the ServicePerimeter. The `short_name`
# component must begin with a letter and only include alphanumeric and '_'.
# Format: `accessPolicies/`policy_id`/servicePerimeters/`short_name``
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Perimeter type indicator. A single project 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.
# Corresponds to the JSON property `perimeterType`
# @return [String]
attr_accessor :perimeter_type
# `ServicePerimeterConfig` specifies a set of Google Cloud resources that
# describe specific Service Perimeter configuration.
# Corresponds to the JSON property `spec`
# @return [Google::Apis::AccesscontextmanagerV1::ServicePerimeterConfig]
attr_accessor :spec
# `ServicePerimeterConfig` specifies a set of Google Cloud resources that
# describe specific Service Perimeter configuration.
# Corresponds to the JSON property `status`
# @return [Google::Apis::AccesscontextmanagerV1::ServicePerimeterConfig]
attr_accessor :status
# Human readable title. Must be unique within the Policy.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :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.
# Corresponds to the JSON property `useExplicitDryRunSpec`
# @return [Boolean]
attr_accessor :use_explicit_dry_run_spec
alias_method :use_explicit_dry_run_spec?, :use_explicit_dry_run_spec
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@name = args[:name] if args.key?(:name)
@perimeter_type = args[:perimeter_type] if args.key?(:perimeter_type)
@spec = args[:spec] if args.key?(:spec)
@status = args[:status] if args.key?(:status)
@title = args[:title] if args.key?(:title)
@use_explicit_dry_run_spec = args[:use_explicit_dry_run_spec] if args.key?(:use_explicit_dry_run_spec)
end
end
# `ServicePerimeterConfig` specifies a set of Google Cloud resources that
# describe specific Service Perimeter configuration.
class ServicePerimeterConfig
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `accessLevels`
# @return [Array<String>]
attr_accessor :access_levels
# A list of Google Cloud resources that are inside of the service perimeter.
# Currently only projects are allowed. Format: `projects/`project_number``
# Corresponds to the JSON property `resources`
# @return [Array<String>]
attr_accessor :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.
# Corresponds to the JSON property `restrictedServices`
# @return [Array<String>]
attr_accessor :restricted_services
# Specifies how APIs are allowed to communicate within the Service
# Perimeter.
# Corresponds to the JSON property `vpcAccessibleServices`
# @return [Google::Apis::AccesscontextmanagerV1::VpcAccessibleServices]
attr_accessor :vpc_accessible_services
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@access_levels = args[:access_levels] if args.key?(:access_levels)
@resources = args[:resources] if args.key?(:resources)
@restricted_services = args[:restricted_services] if args.key?(:restricted_services)
@vpc_accessible_services = args[:vpc_accessible_services] if args.key?(:vpc_accessible_services)
end
end
# 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).
class Status
include Google::Apis::Core::Hashable
# The status code, which should be an enum value of google.rpc.Code.
# Corresponds to the JSON property `code`
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@details = args[:details] if args.key?(:details)
@message = args[:message] if args.key?(:message)
end
end
# Specifies how APIs are allowed to communicate within the Service
# Perimeter.
class VpcAccessibleServices
include Google::Apis::Core::Hashable
# The list of APIs usable within the Service Perimeter. Must be empty
# unless 'enable_restriction' is True.
# Corresponds to the JSON property `allowedServices`
# @return [Array<String>]
attr_accessor :allowed_services
# Whether to restrict API calls within the Service Perimeter to the list of
# APIs specified in 'allowed_services'.
# Corresponds to the JSON property `enableRestriction`
# @return [Boolean]
attr_accessor :enable_restriction
alias_method :enable_restriction?, :enable_restriction
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allowed_services = args[:allowed_services] if args.key?(:allowed_services)
@enable_restriction = args[:enable_restriction] if args.key?(:enable_restriction)
end
end
end
end
end