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

438 lines
19 KiB
Ruby
Raw Normal View History

2015-06-23 23:05:46 +00:00
# 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 CloudresourcemanagerV1beta1
# A Project is a high-level Google Cloud Platform entity. It is a container for
# ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
class Project
include Google::Apis::Core::Hashable
2015-07-20 21:49:34 +00:00
# The number uniquely identifying the project. Example: 415104041262 Read-only.
2015-06-23 23:05:46 +00:00
# Corresponds to the JSON property `projectNumber`
# @return [String]
attr_accessor :project_number
2015-12-14 22:27:57 +00:00
# The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase
2015-06-23 23:05:46 +00:00
# letters, digits, or hyphens. It must start with a letter. Trailing hyphens are
2015-07-20 21:49:34 +00:00
# prohibited. Example: tokyo-rain-123 Read-only after creation.
2015-06-23 23:05:46 +00:00
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
2015-12-14 22:27:57 +00:00
# The Project lifecycle state. Read-only.
2015-06-23 23:05:46 +00:00
# Corresponds to the JSON property `lifecycleState`
# @return [String]
attr_accessor :lifecycle_state
2015-12-14 22:27:57 +00:00
# The user-assigned name of the Project. It must be 4 to 30 characters. Allowed
2015-12-03 01:10:07 +00:00
# characters are: lowercase and uppercase letters, numbers, hyphen, single-quote,
# double-quote, space, and exclamation point. Example: My Project Read-write.
2015-06-23 23:05:46 +00:00
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Creation time. Read-only.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
2015-12-14 22:27:57 +00:00
# The labels associated with this Project. Label keys must be between 1 and 63
2015-07-20 21:49:34 +00:00
# characters long and must conform to the following regular expression: \[a-z\](\
# [-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long
# and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
# No more than 256 labels can be associated with a given resource. Clients
# should store labels in a representation such as JSON that does not depend on
# specific characters being disallowed. Example: "environment" : "dev" Read-
# write.
2015-06-23 23:05:46 +00:00
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
2015-12-14 22:27:57 +00:00
# A container to reference an id for any resource type. A `resource` in Google
2015-12-03 01:10:07 +00:00
# Cloud Platform is a generic term for something you (a developer) may want to
# interact with through one of our API's. Some examples are an AppEngine app, a
2015-12-14 22:27:57 +00:00
# Compute Engine instance, a Cloud SQL database, and so on.
2015-12-03 01:10:07 +00:00
# Corresponds to the JSON property `parent`
# @return [Google::Apis::CloudresourcemanagerV1beta1::ResourceId]
attr_accessor :parent
2015-06-23 23:05:46 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@project_number = args[:project_number] unless args[:project_number].nil?
@project_id = args[:project_id] unless args[:project_id].nil?
@lifecycle_state = args[:lifecycle_state] unless args[:lifecycle_state].nil?
@name = args[:name] unless args[:name].nil?
@create_time = args[:create_time] unless args[:create_time].nil?
@labels = args[:labels] unless args[:labels].nil?
2015-12-03 01:10:07 +00:00
@parent = args[:parent] unless args[:parent].nil?
end
end
2015-12-14 22:27:57 +00:00
# A container to reference an id for any resource type. A `resource` in Google
2015-12-03 01:10:07 +00:00
# Cloud Platform is a generic term for something you (a developer) may want to
# interact with through one of our API's. Some examples are an AppEngine app, a
2015-12-14 22:27:57 +00:00
# Compute Engine instance, a Cloud SQL database, and so on.
2015-12-03 01:10:07 +00:00
class ResourceId
include Google::Apis::Core::Hashable
# Required field representing the resource type this id is for. At present, the
# only valid type is "organization".
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# Required field for the type-specific id. This should correspond to the id used
# in the type-specific API's.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] unless args[:type].nil?
@id = args[:id] unless args[:id].nil?
2015-06-23 23:05:46 +00:00
end
end
2015-12-03 01:10:07 +00:00
# A page of the response received from the ListProjects method. A paginated
# response where more pages are available has `next_page_token` set. This token
# can be used in a subsequent request to retrieve the next request page.
2015-06-23 23:05:46 +00:00
class ListProjectsResponse
include Google::Apis::Core::Hashable
2015-12-14 22:27:57 +00:00
# The list of Projects that matched the list filter. This list can be paginated.
2015-06-23 23:05:46 +00:00
# Corresponds to the JSON property `projects`
# @return [Array<Google::Apis::CloudresourcemanagerV1beta1::Project>]
attr_accessor :projects
# Pagination token. If the result set is too large to fit in a single response,
# this token is returned. It encodes the position of the current result cursor.
# Feeding this value into a new list request with the `page_token` parameter
# gives the next page of the results. When `next_page_token` is not filled in,
# there is no next page and the list returned is the last page in the result set.
2015-12-03 01:10:07 +00:00
# Pagination tokens have a limited lifetime.
2015-06-23 23:05:46 +00:00
# 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)
@projects = args[:projects] unless args[:projects].nil?
@next_page_token = args[:next_page_token] unless args[:next_page_token].nil?
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.
2015-07-20 21:49:34 +00:00
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
2015-06-23 23:05:46 +00:00
class Empty
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
2015-07-31 00:05:47 +00:00
# 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
2015-12-03 01:10:07 +00:00
# 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. **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"] ` ] ` For a description of IAM and its features, see the [
# IAM developer's guide](https://cloud.google.com/iam).
2015-07-31 00:05:47 +00:00
class Policy
include Google::Apis::Core::Hashable
2015-12-14 22:27:57 +00:00
# Version of the `Policy`. The default version is 0.
2015-07-31 00:05:47 +00:00
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
2015-12-03 01:10:07 +00:00
# Associates a list of `members` to a `role`. Multiple `bindings` must not be
# specified for the same `role`. `bindings` with no members will result in an
# error.
2015-07-31 00:05:47 +00:00
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::CloudresourcemanagerV1beta1::Binding>]
attr_accessor :bindings
2015-12-14 22:27:57 +00:00
# `etag` is used for optimistic concurrency control as a way to help prevent
2015-12-03 01:10:07 +00:00
# simultaneous updates of a policy from overwriting each other. It is strongly
2015-12-14 22:27:57 +00:00
# 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.
2015-07-31 00:05:47 +00:00
# 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)
@version = args[:version] unless args[:version].nil?
@bindings = args[:bindings] unless args[:bindings].nil?
@etag = args[:etag] unless args[:etag].nil?
end
end
2015-12-03 01:10:07 +00:00
# Associates `members` with a `role`.
2015-07-31 00:05:47 +00:00
class Binding
include Google::Apis::Core::Hashable
2015-12-03 01:10:07 +00:00
# Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`
# , or `roles/owner`. Required
2015-07-31 00:05:47 +00:00
# Corresponds to the JSON property `role`
# @return [String]
attr_accessor :role
2015-12-03 01:10:07 +00:00
# Specifies the identities requesting access for a Cloud Platform resource. `
2015-12-14 22:27:57 +00:00
# members` can have the following values: * `allUsers`: A special identifier
2015-12-03 01:10:07 +00:00
# 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` or `joe@example.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``: A Google Apps domain name that represents all the users of
# that domain. For example, `google.com` or `example.com`.
2015-07-31 00:05:47 +00:00
# Corresponds to the JSON property `members`
# @return [Array<String>]
attr_accessor :members
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@role = args[:role] unless args[:role].nil?
@members = args[:members] unless args[:members].nil?
end
end
2015-12-03 01:10:07 +00:00
# Request message for `SetIamPolicy` method.
class SetIamPolicyRequest
2015-07-31 00:05:47 +00:00
include Google::Apis::Core::Hashable
2015-12-03 01:10:07 +00:00
# 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. **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"] ` ] ` For a description of IAM and its features, see the [
# IAM developer's guide](https://cloud.google.com/iam).
# Corresponds to the JSON property `policy`
# @return [Google::Apis::CloudresourcemanagerV1beta1::Policy]
attr_accessor :policy
2015-07-31 00:05:47 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2015-12-03 01:10:07 +00:00
@policy = args[:policy] unless args[:policy].nil?
2015-07-31 00:05:47 +00:00
end
end
2015-12-03 01:10:07 +00:00
# Request message for `TestIamPermissions` method.
class TestIamPermissionsRequest
2015-07-31 00:05:47 +00:00
include Google::Apis::Core::Hashable
2015-12-03 01:10:07 +00:00
# The set of permissions to check for the `resource`. Permissions with wildcards
2016-01-14 18:49:46 +00:00
# (such as '*' or 'storage.*') are not allowed. For more information see IAM
# Overview.
2015-12-03 01:10:07 +00:00
# Corresponds to the JSON property `permissions`
2015-07-31 00:05:47 +00:00
# @return [Array<String>]
2015-12-03 01:10:07 +00:00
attr_accessor :permissions
2015-07-31 00:05:47 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2015-12-03 01:10:07 +00:00
@permissions = args[:permissions] unless args[:permissions].nil?
2015-07-31 00:05:47 +00:00
end
end
2015-12-03 01:10:07 +00:00
# Response message for `TestIamPermissions` method.
class TestIamPermissionsResponse
2015-07-31 00:05:47 +00:00
include Google::Apis::Core::Hashable
2015-12-03 01:10:07 +00:00
# A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
2015-07-31 00:05:47 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2015-12-03 01:10:07 +00:00
@permissions = args[:permissions] unless args[:permissions].nil?
2015-07-31 00:05:47 +00:00
end
end
2015-12-14 22:27:57 +00:00
# The response returned from the `ListOrganizations` method.
2015-12-03 01:10:07 +00:00
class ListOrganizationsResponse
2015-07-31 00:05:47 +00:00
include Google::Apis::Core::Hashable
2015-12-03 01:10:07 +00:00
# The list of Organizations that matched the list query, possibly paginated.
# Corresponds to the JSON property `organizations`
# @return [Array<Google::Apis::CloudresourcemanagerV1beta1::Organization>]
attr_accessor :organizations
2015-07-31 00:05:47 +00:00
2015-12-03 01:10:07 +00:00
# A pagination token to be used to retrieve the next page of results. If the
# result is too large to fit within the page size specified in the request, this
# field will be set with a token that can be used to fetch the next page of
# results. If this field is empty, it indicates that this response contains the
# last page of results.
# Corresponds to the JSON property `nextPageToken`
2015-07-31 00:05:47 +00:00
# @return [String]
2015-12-03 01:10:07 +00:00
attr_accessor :next_page_token
2015-07-31 00:05:47 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2015-12-03 01:10:07 +00:00
@organizations = args[:organizations] unless args[:organizations].nil?
@next_page_token = args[:next_page_token] unless args[:next_page_token].nil?
2015-07-31 00:05:47 +00:00
end
end
2015-12-03 01:10:07 +00:00
# The root node in the resource hierarchy to which a particular entity's (e.g.,
# company) resources belong.
class Organization
2015-07-31 00:05:47 +00:00
include Google::Apis::Core::Hashable
2015-12-03 01:10:07 +00:00
# An immutable id for the Organization that is assigned on creation. This should
# be omitted when creating a new Organization. This field is read-only.
# Corresponds to the JSON property `organizationId`
# @return [String]
attr_accessor :organization_id
2015-07-31 00:05:47 +00:00
2015-12-03 01:10:07 +00:00
# A friendly string to be used to refer to the Organization in the UI. This
# field is required.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The entity that owns an Organization. The lifetime of the Organization and all
2015-12-14 22:27:57 +00:00
# of its descendants are bound to the `OrganizationOwner`. If the `
# OrganizationOwner` is deleted, the Organization and all its descendants will
# be deleted.
2015-12-03 01:10:07 +00:00
# Corresponds to the JSON property `owner`
# @return [Google::Apis::CloudresourcemanagerV1beta1::OrganizationOwner]
attr_accessor :owner
# Timestamp when the Organization was created. Assigned by the server. @
# OutputOnly
# Corresponds to the JSON property `creationTime`
# @return [String]
attr_accessor :creation_time
2015-07-31 00:05:47 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2015-12-03 01:10:07 +00:00
@organization_id = args[:organization_id] unless args[:organization_id].nil?
@display_name = args[:display_name] unless args[:display_name].nil?
@owner = args[:owner] unless args[:owner].nil?
@creation_time = args[:creation_time] unless args[:creation_time].nil?
2015-07-31 00:05:47 +00:00
end
end
2015-12-03 01:10:07 +00:00
# The entity that owns an Organization. The lifetime of the Organization and all
2015-12-14 22:27:57 +00:00
# of its descendants are bound to the `OrganizationOwner`. If the `
# OrganizationOwner` is deleted, the Organization and all its descendants will
# be deleted.
2015-12-03 01:10:07 +00:00
class OrganizationOwner
2015-07-31 00:05:47 +00:00
include Google::Apis::Core::Hashable
2015-12-03 01:10:07 +00:00
# The Google for Work customer id used in the Directory API.
# Corresponds to the JSON property `directoryCustomerId`
# @return [String]
attr_accessor :directory_customer_id
2015-07-31 00:05:47 +00:00
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2015-12-03 01:10:07 +00:00
@directory_customer_id = args[:directory_customer_id] unless args[:directory_customer_id].nil?
2015-07-31 00:05:47 +00:00
end
end
2015-06-23 23:05:46 +00:00
end
end
end