901 lines
36 KiB
Ruby
901 lines
36 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 CloudresourcemanagerV2
|
||
|
||
# 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:foo@gmail.com"
|
||
# ]
|
||
# `,
|
||
# `
|
||
# "log_type": "DATA_WRITE",
|
||
# `,
|
||
# `
|
||
# "log_type": "ADMIN_READ",
|
||
# `
|
||
# ]
|
||
# `,
|
||
# `
|
||
# "service": "fooservice.googleapis.com"
|
||
# "audit_log_configs": [
|
||
# `
|
||
# "log_type": "DATA_READ",
|
||
# `,
|
||
# `
|
||
# "log_type": "DATA_WRITE",
|
||
# "exempted_members": [
|
||
# "user:bar@gmail.com"
|
||
# ]
|
||
# `
|
||
# ]
|
||
# `
|
||
# ]
|
||
# `
|
||
# For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
|
||
# logging. It also exempts foo@gmail.com from DATA_READ logging, and
|
||
# bar@gmail.com from DATA_WRITE logging.
|
||
class AuditConfig
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# The configuration for logging of each type of permission.
|
||
# Corresponds to the JSON property `auditLogConfigs`
|
||
# @return [Array<Google::Apis::CloudresourcemanagerV2::AuditLogConfig>]
|
||
attr_accessor :audit_log_configs
|
||
|
||
# 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.
|
||
# Corresponds to the JSON property `service`
|
||
# @return [String]
|
||
attr_accessor :service
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
@audit_log_configs = args[:audit_log_configs] if args.key?(:audit_log_configs)
|
||
@service = args[:service] if args.key?(:service)
|
||
end
|
||
end
|
||
|
||
# Provides the configuration for logging a type of permissions.
|
||
# Example:
|
||
# `
|
||
# "audit_log_configs": [
|
||
# `
|
||
# "log_type": "DATA_READ",
|
||
# "exempted_members": [
|
||
# "user:foo@gmail.com"
|
||
# ]
|
||
# `,
|
||
# `
|
||
# "log_type": "DATA_WRITE",
|
||
# `
|
||
# ]
|
||
# `
|
||
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
|
||
# foo@gmail.com from DATA_READ logging.
|
||
class AuditLogConfig
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# Specifies the identities that do not cause logging for this type of
|
||
# permission.
|
||
# Follows the same format of Binding.members.
|
||
# Corresponds to the JSON property `exemptedMembers`
|
||
# @return [Array<String>]
|
||
attr_accessor :exempted_members
|
||
|
||
# The log type that this config enables.
|
||
# Corresponds to the JSON property `logType`
|
||
# @return [String]
|
||
attr_accessor :log_type
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
@exempted_members = args[:exempted_members] if args.key?(:exempted_members)
|
||
@log_type = args[:log_type] if args.key?(:log_type)
|
||
end
|
||
end
|
||
|
||
# Associates `members` with a `role`.
|
||
class Binding
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# Represents an expression text. Example:
|
||
# title: "User account presence"
|
||
# description: "Determines whether the request has a user account"
|
||
# expression: "size(request.user) > 0"
|
||
# Corresponds to the JSON property `condition`
|
||
# @return [Google::Apis::CloudresourcemanagerV2::Expr]
|
||
attr_accessor :condition
|
||
|
||
# Specifies the identities requesting access for a Cloud Platform 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.
|
||
# * `user:`emailid``: An email address that represents a specific Google
|
||
# account. For example, `alice@gmail.com` .
|
||
# * `serviceAccount:`emailid``: An email address that represents a service
|
||
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
|
||
# * `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`.
|
||
# Corresponds to the JSON property `members`
|
||
# @return [Array<String>]
|
||
attr_accessor :members
|
||
|
||
# Role that is assigned to `members`.
|
||
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
|
||
# Corresponds to the JSON property `role`
|
||
# @return [String]
|
||
attr_accessor :role
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
@condition = args[:condition] if args.key?(:condition)
|
||
@members = args[:members] if args.key?(:members)
|
||
@role = args[:role] if args.key?(:role)
|
||
end
|
||
end
|
||
|
||
# Represents an expression text. Example:
|
||
# title: "User account presence"
|
||
# description: "Determines whether the request has a user account"
|
||
# expression: "size(request.user) > 0"
|
||
class Expr
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# An 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.
|
||
# The application context of the containing message determines which
|
||
# well-known feature set of CEL is supported.
|
||
# Corresponds to the JSON property `expression`
|
||
# @return [String]
|
||
attr_accessor :expression
|
||
|
||
# An 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
|
||
|
||
# An 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 Folder in an Organization's resource hierarchy, used to
|
||
# organize that Organization's resources.
|
||
class Folder
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# Output only. Timestamp when the Folder was created. Assigned by the server.
|
||
# Corresponds to the JSON property `createTime`
|
||
# @return [String]
|
||
attr_accessor :create_time
|
||
|
||
# The folder’s display name.
|
||
# A folder’s display name must be unique amongst its siblings, e.g.
|
||
# no two folders with the same parent can share the same display name.
|
||
# The display name must start and end with a letter or digit, may contain
|
||
# letters, digits, spaces, hyphens and underscores and can be no longer
|
||
# than 30 characters. This is captured by the regular expression:
|
||
# [\p`L`\p`N`]([\p`L`\p`N`_- ]`0,28`[\p`L`\p`N`])?.
|
||
# Corresponds to the JSON property `displayName`
|
||
# @return [String]
|
||
attr_accessor :display_name
|
||
|
||
# Output only. The lifecycle state of the folder.
|
||
# Updates to the lifecycle_state must be performed via
|
||
# DeleteFolder and
|
||
# UndeleteFolder.
|
||
# Corresponds to the JSON property `lifecycleState`
|
||
# @return [String]
|
||
attr_accessor :lifecycle_state
|
||
|
||
# Output only. The resource name of the Folder.
|
||
# Its format is `folders/`folder_id``, for example: "folders/1234".
|
||
# Corresponds to the JSON property `name`
|
||
# @return [String]
|
||
attr_accessor :name
|
||
|
||
# The Folder’s parent's resource name.
|
||
# Updates to the folder's parent must be performed via
|
||
# MoveFolder.
|
||
# Corresponds to the JSON property `parent`
|
||
# @return [String]
|
||
attr_accessor :parent
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
@create_time = args[:create_time] if args.key?(:create_time)
|
||
@display_name = args[:display_name] if args.key?(:display_name)
|
||
@lifecycle_state = args[:lifecycle_state] if args.key?(:lifecycle_state)
|
||
@name = args[:name] if args.key?(:name)
|
||
@parent = args[:parent] if args.key?(:parent)
|
||
end
|
||
end
|
||
|
||
# Metadata describing a long running folder operation
|
||
class FolderOperation
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# The resource name of the folder or organization we are either creating
|
||
# the folder under or moving the folder to.
|
||
# Corresponds to the JSON property `destinationParent`
|
||
# @return [String]
|
||
attr_accessor :destination_parent
|
||
|
||
# The display name of the folder.
|
||
# Corresponds to the JSON property `displayName`
|
||
# @return [String]
|
||
attr_accessor :display_name
|
||
|
||
# The type of this operation.
|
||
# Corresponds to the JSON property `operationType`
|
||
# @return [String]
|
||
attr_accessor :operation_type
|
||
|
||
# The resource name of the folder's parent.
|
||
# Only applicable when the operation_type is MOVE.
|
||
# Corresponds to the JSON property `sourceParent`
|
||
# @return [String]
|
||
attr_accessor :source_parent
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
@destination_parent = args[:destination_parent] if args.key?(:destination_parent)
|
||
@display_name = args[:display_name] if args.key?(:display_name)
|
||
@operation_type = args[:operation_type] if args.key?(:operation_type)
|
||
@source_parent = args[:source_parent] if args.key?(:source_parent)
|
||
end
|
||
end
|
||
|
||
# A classification of the Folder Operation error.
|
||
class FolderOperationError
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# The type of operation error experienced.
|
||
# Corresponds to the JSON property `errorMessageId`
|
||
# @return [String]
|
||
attr_accessor :error_message_id
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
@error_message_id = args[:error_message_id] if args.key?(:error_message_id)
|
||
end
|
||
end
|
||
|
||
# Request message for `GetIamPolicy` method.
|
||
class GetIamPolicyRequest
|
||
include Google::Apis::Core::Hashable
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
end
|
||
end
|
||
|
||
# The ListFolders response message.
|
||
class ListFoldersResponse
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# A possibly paginated list of Folders that are direct descendants of
|
||
# the specified parent resource.
|
||
# Corresponds to the JSON property `folders`
|
||
# @return [Array<Google::Apis::CloudresourcemanagerV2::Folder>]
|
||
attr_accessor :folders
|
||
|
||
# A pagination token returned from a previous call to `ListFolders`
|
||
# that indicates from where listing should continue.
|
||
# This field is optional.
|
||
# 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)
|
||
@folders = args[:folders] if args.key?(:folders)
|
||
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
||
end
|
||
end
|
||
|
||
# The MoveFolder request message.
|
||
class MoveFolderRequest
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# The resource name of the Folder or Organization to reparent
|
||
# the folder under.
|
||
# Must be of the form `folders/`folder_id`` or `organizations/`org_id``.
|
||
# Corresponds to the JSON property `destinationParent`
|
||
# @return [String]
|
||
attr_accessor :destination_parent
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
@destination_parent = args[:destination_parent] if args.key?(:destination_parent)
|
||
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). The error model is designed to be:
|
||
# - Simple to use and understand for most users
|
||
# - Flexible enough to meet unexpected needs
|
||
# # Overview
|
||
# The `Status` message contains three pieces of data: error code, error
|
||
# message, and error details. The error code should be an enum value of
|
||
# google.rpc.Code, but it may accept additional error codes if needed. The
|
||
# error message should be a developer-facing English message that helps
|
||
# developers *understand* and *resolve* the error. If a localized user-facing
|
||
# error message is needed, put the localized message in the error details or
|
||
# localize it in the client. The optional error details may contain arbitrary
|
||
# information about the error. There is a predefined set of error detail types
|
||
# in the package `google.rpc` that can be used for common error conditions.
|
||
# # Language mapping
|
||
# The `Status` message is the logical representation of the error model, but it
|
||
# is not necessarily the actual wire format. When the `Status` message is
|
||
# exposed in different client libraries and different wire protocols, it can be
|
||
# mapped differently. For example, it will likely be mapped to some exceptions
|
||
# in Java, but more likely mapped to some error codes in C.
|
||
# # Other uses
|
||
# The error model and the `Status` message can be used in a variety of
|
||
# environments, either with or without APIs, to provide a
|
||
# consistent developer experience across different environments.
|
||
# Example uses of this error model include:
|
||
# - Partial errors. If a service needs to return partial errors to the client,
|
||
# it may embed the `Status` in the normal response to indicate the partial
|
||
# errors.
|
||
# - Workflow errors. A typical workflow has multiple steps. Each step may
|
||
# have a `Status` message for error reporting.
|
||
# - Batch operations. If a client uses batch request and batch response, the
|
||
# `Status` message should be used directly inside batch response, one for
|
||
# each error sub-response.
|
||
# - Asynchronous operations. If an API call embeds asynchronous operation
|
||
# results in its response, the status of those operations should be
|
||
# represented directly using the `Status` message.
|
||
# - Logging. If some API errors are stored in logs, the message `Status` could
|
||
# be used directly after any stripping needed for security/privacy reasons.
|
||
# Corresponds to the JSON property `error`
|
||
# @return [Google::Apis::CloudresourcemanagerV2::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
|
||
|
||
# Defines an Identity and Access Management (IAM) policy. It is used to
|
||
# specify access control policies for Cloud Platform resources.
|
||
# A `Policy` consists of a list of `bindings`. A `binding` binds a list of
|
||
# `members` to a `role`, where the members can be user accounts, Google groups,
|
||
# Google domains, and service accounts. A `role` is a named list of permissions
|
||
# defined by IAM.
|
||
# **JSON Example**
|
||
# `
|
||
# "bindings": [
|
||
# `
|
||
# "role": "roles/owner",
|
||
# "members": [
|
||
# "user:mike@example.com",
|
||
# "group:admins@example.com",
|
||
# "domain:google.com",
|
||
# "serviceAccount:my-other-app@appspot.gserviceaccount.com"
|
||
# ]
|
||
# `,
|
||
# `
|
||
# "role": "roles/viewer",
|
||
# "members": ["user:sean@example.com"]
|
||
# `
|
||
# ]
|
||
# `
|
||
# **YAML Example**
|
||
# bindings:
|
||
# - members:
|
||
# - user:mike@example.com
|
||
# - group:admins@example.com
|
||
# - domain:google.com
|
||
# - serviceAccount:my-other-app@appspot.gserviceaccount.com
|
||
# role: roles/owner
|
||
# - members:
|
||
# - user:sean@example.com
|
||
# role: roles/viewer
|
||
# For a description of IAM and its features, see the
|
||
# [IAM developer's guide](https://cloud.google.com/iam/docs).
|
||
class Policy
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# Specifies cloud audit logging configuration for this policy.
|
||
# Corresponds to the JSON property `auditConfigs`
|
||
# @return [Array<Google::Apis::CloudresourcemanagerV2::AuditConfig>]
|
||
attr_accessor :audit_configs
|
||
|
||
# Associates a list of `members` to a `role`.
|
||
# `bindings` with no members will result in an error.
|
||
# Corresponds to the JSON property `bindings`
|
||
# @return [Array<Google::Apis::CloudresourcemanagerV2::Binding>]
|
||
attr_accessor :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.
|
||
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
|
||
# policy is overwritten blindly.
|
||
# Corresponds to the JSON property `etag`
|
||
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
||
# @return [String]
|
||
attr_accessor :etag
|
||
|
||
# Deprecated.
|
||
# Corresponds to the JSON property `version`
|
||
# @return [Fixnum]
|
||
attr_accessor :version
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
@audit_configs = args[:audit_configs] if args.key?(:audit_configs)
|
||
@bindings = args[:bindings] if args.key?(:bindings)
|
||
@etag = args[:etag] if args.key?(:etag)
|
||
@version = args[:version] if args.key?(:version)
|
||
end
|
||
end
|
||
|
||
# A status object which is used as the `metadata` field for the Operation
|
||
# returned by CreateProject. It provides insight for when significant phases of
|
||
# Project creation have completed.
|
||
class ProjectCreationStatus
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# Creation time of the project creation workflow.
|
||
# Corresponds to the JSON property `createTime`
|
||
# @return [String]
|
||
attr_accessor :create_time
|
||
|
||
# True if the project can be retrieved using GetProject. No other operations
|
||
# on the project are guaranteed to work until the project creation is
|
||
# complete.
|
||
# Corresponds to the JSON property `gettable`
|
||
# @return [Boolean]
|
||
attr_accessor :gettable
|
||
alias_method :gettable?, :gettable
|
||
|
||
# True if the project creation process is complete.
|
||
# Corresponds to the JSON property `ready`
|
||
# @return [Boolean]
|
||
attr_accessor :ready
|
||
alias_method :ready?, :ready
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
@create_time = args[:create_time] if args.key?(:create_time)
|
||
@gettable = args[:gettable] if args.key?(:gettable)
|
||
@ready = args[:ready] if args.key?(:ready)
|
||
end
|
||
end
|
||
|
||
# The request message for searching folders.
|
||
class SearchFoldersRequest
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# The maximum number of folders to return in the response.
|
||
# This field is optional.
|
||
# Corresponds to the JSON property `pageSize`
|
||
# @return [Fixnum]
|
||
attr_accessor :page_size
|
||
|
||
# A pagination token returned from a previous call to `SearchFolders`
|
||
# that indicates from where search should continue.
|
||
# This field is optional.
|
||
# Corresponds to the JSON property `pageToken`
|
||
# @return [String]
|
||
attr_accessor :page_token
|
||
|
||
# Search criteria used to select the Folders to return.
|
||
# If no search criteria is specified then all accessible folders will be
|
||
# returned.
|
||
# Query expressions can be used to restrict results based upon displayName,
|
||
# lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`
|
||
# can be used along with the suffix wildcard symbol `*`.
|
||
# The displayName field in a query expression should use escaped quotes
|
||
# for values that include whitespace to prevent unexpected behavior.
|
||
# Some example queries are:
|
||
# |Query | Description|
|
||
# |----- | -----------|
|
||
# |displayName=Test* | Folders whose display name starts with "Test".|
|
||
# |lifecycleState=ACTIVE | Folders whose lifecycleState is ACTIVE.|
|
||
# |parent=folders/123 | Folders whose parent is "folders/123".|
|
||
# |parent=folders/123 AND lifecycleState=ACTIVE | Active folders whose parent
|
||
# is "folders/123".| |displayName=\\"Test String\\"|Folders whose display
|
||
# name includes both "Test" and "String".|
|
||
# Corresponds to the JSON property `query`
|
||
# @return [String]
|
||
attr_accessor :query
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
@page_size = args[:page_size] if args.key?(:page_size)
|
||
@page_token = args[:page_token] if args.key?(:page_token)
|
||
@query = args[:query] if args.key?(:query)
|
||
end
|
||
end
|
||
|
||
# The response message for searching folders.
|
||
class SearchFoldersResponse
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# A possibly paginated folder search results.
|
||
# the specified parent resource.
|
||
# Corresponds to the JSON property `folders`
|
||
# @return [Array<Google::Apis::CloudresourcemanagerV2::Folder>]
|
||
attr_accessor :folders
|
||
|
||
# A pagination token returned from a previous call to `SearchFolders`
|
||
# that indicates from where searching should continue.
|
||
# This field is optional.
|
||
# 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)
|
||
@folders = args[:folders] if args.key?(:folders)
|
||
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
||
end
|
||
end
|
||
|
||
# Request message for `SetIamPolicy` method.
|
||
class SetIamPolicyRequest
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# Defines an Identity and Access Management (IAM) policy. It is used to
|
||
# specify access control policies for Cloud Platform resources.
|
||
# A `Policy` consists of a list of `bindings`. A `binding` binds a list of
|
||
# `members` to a `role`, where the members can be user accounts, Google groups,
|
||
# Google domains, and service accounts. A `role` is a named list of permissions
|
||
# defined by IAM.
|
||
# **JSON Example**
|
||
# `
|
||
# "bindings": [
|
||
# `
|
||
# "role": "roles/owner",
|
||
# "members": [
|
||
# "user:mike@example.com",
|
||
# "group:admins@example.com",
|
||
# "domain:google.com",
|
||
# "serviceAccount:my-other-app@appspot.gserviceaccount.com"
|
||
# ]
|
||
# `,
|
||
# `
|
||
# "role": "roles/viewer",
|
||
# "members": ["user:sean@example.com"]
|
||
# `
|
||
# ]
|
||
# `
|
||
# **YAML Example**
|
||
# bindings:
|
||
# - members:
|
||
# - user:mike@example.com
|
||
# - group:admins@example.com
|
||
# - domain:google.com
|
||
# - serviceAccount:my-other-app@appspot.gserviceaccount.com
|
||
# role: roles/owner
|
||
# - members:
|
||
# - user:sean@example.com
|
||
# role: roles/viewer
|
||
# For a description of IAM and its features, see the
|
||
# [IAM developer's guide](https://cloud.google.com/iam/docs).
|
||
# Corresponds to the JSON property `policy`
|
||
# @return [Google::Apis::CloudresourcemanagerV2::Policy]
|
||
attr_accessor :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"
|
||
# This field is only used by Cloud IAM.
|
||
# Corresponds to the JSON property `updateMask`
|
||
# @return [String]
|
||
attr_accessor :update_mask
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
@policy = args[:policy] if args.key?(:policy)
|
||
@update_mask = args[:update_mask] if args.key?(:update_mask)
|
||
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). The error model is designed to be:
|
||
# - Simple to use and understand for most users
|
||
# - Flexible enough to meet unexpected needs
|
||
# # Overview
|
||
# The `Status` message contains three pieces of data: error code, error
|
||
# message, and error details. The error code should be an enum value of
|
||
# google.rpc.Code, but it may accept additional error codes if needed. The
|
||
# error message should be a developer-facing English message that helps
|
||
# developers *understand* and *resolve* the error. If a localized user-facing
|
||
# error message is needed, put the localized message in the error details or
|
||
# localize it in the client. The optional error details may contain arbitrary
|
||
# information about the error. There is a predefined set of error detail types
|
||
# in the package `google.rpc` that can be used for common error conditions.
|
||
# # Language mapping
|
||
# The `Status` message is the logical representation of the error model, but it
|
||
# is not necessarily the actual wire format. When the `Status` message is
|
||
# exposed in different client libraries and different wire protocols, it can be
|
||
# mapped differently. For example, it will likely be mapped to some exceptions
|
||
# in Java, but more likely mapped to some error codes in C.
|
||
# # Other uses
|
||
# The error model and the `Status` message can be used in a variety of
|
||
# environments, either with or without APIs, to provide a
|
||
# consistent developer experience across different environments.
|
||
# Example uses of this error model include:
|
||
# - Partial errors. If a service needs to return partial errors to the client,
|
||
# it may embed the `Status` in the normal response to indicate the partial
|
||
# errors.
|
||
# - Workflow errors. A typical workflow has multiple steps. Each step may
|
||
# have a `Status` message for error reporting.
|
||
# - Batch operations. If a client uses batch request and batch response, the
|
||
# `Status` message should be used directly inside batch response, one for
|
||
# each error sub-response.
|
||
# - Asynchronous operations. If an API call embeds asynchronous operation
|
||
# results in its response, the status of those operations should be
|
||
# represented directly using the `Status` message.
|
||
# - Logging. If some API errors are stored in logs, the message `Status` could
|
||
# be used directly after any stripping needed for security/privacy reasons.
|
||
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
|
||
|
||
# Request message for `TestIamPermissions` method.
|
||
class TestIamPermissionsRequest
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# The set of permissions to check for the `resource`. Permissions with
|
||
# wildcards (such as '*' or 'storage.*') are not allowed. For more
|
||
# information see
|
||
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
|
||
# Corresponds to the JSON property `permissions`
|
||
# @return [Array<String>]
|
||
attr_accessor :permissions
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
@permissions = args[:permissions] if args.key?(:permissions)
|
||
end
|
||
end
|
||
|
||
# Response message for `TestIamPermissions` method.
|
||
class TestIamPermissionsResponse
|
||
include Google::Apis::Core::Hashable
|
||
|
||
# A subset of `TestPermissionsRequest.permissions` that the caller is
|
||
# allowed.
|
||
# Corresponds to the JSON property `permissions`
|
||
# @return [Array<String>]
|
||
attr_accessor :permissions
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
@permissions = args[:permissions] if args.key?(:permissions)
|
||
end
|
||
end
|
||
|
||
# The UndeleteFolder request message.
|
||
class UndeleteFolderRequest
|
||
include Google::Apis::Core::Hashable
|
||
|
||
def initialize(**args)
|
||
update!(**args)
|
||
end
|
||
|
||
# Update properties of this object
|
||
def update!(**args)
|
||
end
|
||
end
|
||
end
|
||
end
|
||
end
|