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

1213 lines
48 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 CloudprivatecatalogproducerV1beta1
# An association tuple that pairs a `Catalog` to a resource
# that can use the `Catalog`. After association, a
# google.cloud.privatecatalog.v1beta1.Catalog becomes available to
# consumers under specified Association.resource and all of its child
# nodes.
# Users who have the `cloudprivatecatalog.targets.get` permission on any of
# the resource nodes can access the catalog and child products under the node.
# For example, suppose the cloud resource hierarchy is as follows:
# * organizations/example.com
# * folders/team
# * projects/test
# After creating an association with `organizations/example.com`, the catalog
# `catalogs/1` is accessible from the following paths:
# * organizations/example.com
# * folders/team
# * projects/test
# Users can access them by
# google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action.
class GoogleCloudPrivatecatalogproducerV1beta1Association
include Google::Apis::Core::Hashable
# The creation time of the association.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Output only. The resource name of the catalog association, in the format
# `catalogs/`catalog_id`/associations/`association_id`'.
# A unique identifier for the catalog association, which is
# generated by catalog service.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Required. The user-supplied fully qualified name of the `Resource`
# associated to the `Catalog`. It supports `Organization`, `Folder`,
# and `Project`. Values are of the form
# * `//cloudresourcemanager.googleapis.com/projects/`product_number``
# * `//cloudresourcemanager.googleapis.com/folders/`folder_id``
# * `//cloudresourcemanager.googleapis.com/organizations/`organization_id``
# Corresponds to the JSON property `resource`
# @return [String]
attr_accessor :resource
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@create_time = args[:create_time] if args.key?(:create_time)
@name = args[:name] if args.key?(:name)
@resource = args[:resource] if args.key?(:resource)
end
end
# The producer representation of a catalog which is a curated collection of
# solutions that can be managed, controlled, and shared by cloud admins.
class GoogleCloudPrivatecatalogproducerV1beta1Catalog
include Google::Apis::Core::Hashable
# Output only. The time when the catalog was created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Required. The user-supplied description of the catalog. Maximum of 512
# characters.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Required. The user-supplied descriptive name of the catalog as it appears
# in UIs. Maximum 256 characters in length.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Output only. The resource name of the catalog, in the format
# `catalogs/`catalog_id`'.
# A unique identifier for the catalog, which is generated
# by catalog service.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Required. The parent resource name of the catalog, which can't be changed
# after a catalog is created. It can only be an organization. Values are of
# the form `//cloudresourcemanager.googleapis.com/organizations/<id>`.
# Maximum 256 characters in length.
# Corresponds to the JSON property `parent`
# @return [String]
attr_accessor :parent
# Output only. The time when the catalog was last updated.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@create_time = args[:create_time] if args.key?(:create_time)
@description = args[:description] if args.key?(:description)
@display_name = args[:display_name] if args.key?(:display_name)
@name = args[:name] if args.key?(:name)
@parent = args[:parent] if args.key?(:parent)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
#
class GoogleCloudPrivatecatalogproducerV1beta1CopyProductRequest
include Google::Apis::Core::Hashable
# The resource name of the destination product that is copied to.
# Corresponds to the JSON property `destinationProductName`
# @return [String]
attr_accessor :destination_product_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@destination_product_name = args[:destination_product_name] if args.key?(:destination_product_name)
end
end
#
class GoogleCloudPrivatecatalogproducerV1beta1CreateAssociationRequest
include Google::Apis::Core::Hashable
# An association tuple that pairs a `Catalog` to a resource
# that can use the `Catalog`. After association, a
# google.cloud.privatecatalog.v1beta1.Catalog becomes available to
# consumers under specified Association.resource and all of its child
# nodes.
# Users who have the `cloudprivatecatalog.targets.get` permission on any of
# the resource nodes can access the catalog and child products under the node.
# For example, suppose the cloud resource hierarchy is as follows:
# * organizations/example.com
# * folders/team
# * projects/test
# After creating an association with `organizations/example.com`, the catalog
# `catalogs/1` is accessible from the following paths:
# * organizations/example.com
# * folders/team
# * projects/test
# Users can access them by
# google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action.
# Corresponds to the JSON property `association`
# @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association]
attr_accessor :association
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@association = args[:association] if args.key?(:association)
end
end
#
class GoogleCloudPrivatecatalogproducerV1beta1ListAssociationsResponse
include Google::Apis::Core::Hashable
# The returned `Association` resources from the list call.
# Corresponds to the JSON property `associations`
# @return [Array<Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association>]
attr_accessor :associations
# A pagination token returned from a previous call to
# `ListAssociations` that indicates where the listing should continue from.
# 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)
@associations = args[:associations] if args.key?(:associations)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
#
class GoogleCloudPrivatecatalogproducerV1beta1ListCatalogsResponse
include Google::Apis::Core::Hashable
# The `Catalogs` returned from the list call.
# Corresponds to the JSON property `catalogs`
# @return [Array<Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog>]
attr_accessor :catalogs
# A pagination token returned from a previous call to ListCatalogs
# that indicates where the listing should continue from.
# 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)
@catalogs = args[:catalogs] if args.key?(:catalogs)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
#
class GoogleCloudPrivatecatalogproducerV1beta1ListProductsResponse
include Google::Apis::Core::Hashable
# A pagination token returned from a previous call to ListProducts
# that indicates where the listing should continue from.
# This field is optional.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The `Product` returned from the list call.
# Corresponds to the JSON property `products`
# @return [Array<Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product>]
attr_accessor :products
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)
@products = args[:products] if args.key?(:products)
end
end
#
class GoogleCloudPrivatecatalogproducerV1beta1ListVersionsResponse
include Google::Apis::Core::Hashable
# A pagination token returned from a previous call to ListProducts
# that indicates where the listing should continue from.
# This field is optional.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The `VersiVersionon` returned from the list call.
# Corresponds to the JSON property `versions`
# @return [Array<Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version>]
attr_accessor :versions
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)
@versions = args[:versions] if args.key?(:versions)
end
end
# The producer representation of a product which is a child resource of
# `Catalog` with display metadata and a list of `Version` resources.
class GoogleCloudPrivatecatalogproducerV1beta1Product
include Google::Apis::Core::Hashable
# Required. The type of the product asset, which cannot be changed after the
# product is created. It supports the values
# `google.deploymentmanager.Template` and
# `google.cloudprivatecatalog.ListingOnly`. Other values will be
# rejected by the server. Read only after creation.
# The following fields or resource types have different validation rules
# under each `asset_type` values:
# * Product.display_metadata has different validation schema for each
# asset type value. See its comment for details.
# * Version resource isn't allowed to be added under the
# `google.cloudprivatecatalog.ListingOnly` type.
# Corresponds to the JSON property `assetType`
# @return [String]
attr_accessor :asset_type
# Output only. The time when the product was created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# The user-supplied display metadata to describe the product.
# The JSON schema of the metadata differs by Product.asset_type.
# When the type is `google.deploymentmanager.Template`, the schema is as
# follows:
# ```
# "$schema": http://json-schema.org/draft-04/schema#
# type: object
# properties:
# name:
# type: string
# minLength: 1
# maxLength: 64
# description:
# type: string
# minLength: 1
# maxLength: 2048
# tagline:
# type: string
# minLength: 1
# maxLength: 100
# support_info:
# type: string
# minLength: 1
# maxLength: 2048
# creator:
# type: string
# minLength: 1
# maxLength: 100
# documentation:
# type: array
# items:
# type: object
# properties:
# url:
# type: string
# pattern:
# "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
# title:
# type: string
# minLength: 1
# maxLength: 64
# description:
# type: string
# minLength: 1
# maxLength: 2048
# required:
# - name
# - description
# additionalProperties: false
# ```
# When the asset type is `google.cloudprivatecatalog.ListingOnly`, the schema
# is as follows:
# ```
# "$schema": http://json-schema.org/draft-04/schema#
# type: object
# properties:
# name:
# type: string
# minLength: 1
# maxLength: 64
# description:
# type: string
# minLength: 1
# maxLength: 2048
# tagline:
# type: string
# minLength: 1
# maxLength: 100
# support_info:
# type: string
# minLength: 1
# maxLength: 2048
# creator:
# type: string
# minLength: 1
# maxLength: 100
# documentation:
# type: array
# items:
# type: object
# properties:
# url:
# type: string
# pattern:
# "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
# title:
# type: string
# minLength: 1
# maxLength: 64
# description:
# type: string
# minLength: 1
# maxLength: 2048
# signup_url:
# type: string
# pattern:
# "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
# required:
# - name
# - description
# - signup_url
# additionalProperties: false
# ```
# Corresponds to the JSON property `displayMetadata`
# @return [Hash<String,Object>]
attr_accessor :display_metadata
# Output only. The public accessible URI of the icon uploaded by
# PrivateCatalogProducer.UploadIcon.
# If no icon is uploaded, it will be the default icon's URI.
# Corresponds to the JSON property `iconUri`
# @return [String]
attr_accessor :icon_uri
# Required. The resource name of the product in the format
# `catalogs/`catalog_id`/products/a-z*[a-z0-9]'.
# A unique identifier for the product under a catalog, which cannot
# be changed after the product is created. The final
# segment of the name must between 1 and 256 characters in length.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Output only. The time when the product was last updated.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@asset_type = args[:asset_type] if args.key?(:asset_type)
@create_time = args[:create_time] if args.key?(:create_time)
@display_metadata = args[:display_metadata] if args.key?(:display_metadata)
@icon_uri = args[:icon_uri] if args.key?(:icon_uri)
@name = args[:name] if args.key?(:name)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
#
class GoogleCloudPrivatecatalogproducerV1beta1UndeleteCatalogRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
#
class GoogleCloudPrivatecatalogproducerV1beta1UploadIconRequest
include Google::Apis::Core::Hashable
# The raw icon bytes user-supplied to be uploaded to the product. The format
# of the icon can only be PNG or JPEG. The minimum allowed dimensions are
# 130x130 pixels and the maximum dimensions are 10000x10000 pixels.
# Required.
# Corresponds to the JSON property `icon`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :icon
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@icon = args[:icon] if args.key?(:icon)
end
end
# The producer representation of a version, which is a child resource under a
# `Product` with asset data.
class GoogleCloudPrivatecatalogproducerV1beta1Version
include Google::Apis::Core::Hashable
# Output only. The asset which has been validated and is ready to be
# provisioned. See Version.original_asset for the schema.
# Corresponds to the JSON property `asset`
# @return [Hash<String,Object>]
attr_accessor :asset
# Output only. The time when the version was created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# The user-supplied description of the version. Maximum of 256 characters.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Required. The resource name of the version, in the format
# `catalogs/`catalog_id`/products/`product_id`/versions/a-z*[a-z0-9]'.
# A unique identifier for the version under a product, which can't
# be changed after the version is created. The final segment of the name must
# between 1 and 63 characters in length.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The user-supplied asset payload. The maximum size of the payload is 2MB.
# The JSON schema of the payload is defined as:
# ```
# type: object
# properties:
# mainTemplate:
# type: string
# description: The file name of the main template and name prefix of
# schema file. The content of the main template should be set in the
# imports list. The schema file name is expected to be
# <mainTemplate>.schema in the imports list. required: true
# imports:
# type: array
# description: Import template and schema file contents. Required to have
# both <mainTemplate> and <mainTemplate>.schema files. required: true
# minItems: 2
# items:
# type: object
# properties:
# name:
# type: string
# content:
# type: string
# ```
# Corresponds to the JSON property `originalAsset`
# @return [Hash<String,Object>]
attr_accessor :original_asset
# Output only. The time when the version was last updated.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@asset = args[:asset] if args.key?(:asset)
@create_time = args[:create_time] if args.key?(:create_time)
@description = args[:description] if args.key?(:description)
@name = args[:name] if args.key?(:name)
@original_asset = args[:original_asset] if args.key?(:original_asset)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
# 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 GoogleIamV1AuditConfig
include Google::Apis::Core::Hashable
# The configuration for logging of each type of permission.
# Corresponds to the JSON property `auditLogConfigs`
# @return [Array<Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1AuditLogConfig>]
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 GoogleIamV1AuditLogConfig
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 GoogleIamV1Binding
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::CloudprivatecatalogproducerV1beta1::GoogleTypeExpr]
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
# 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 GoogleIamV1Policy
include Google::Apis::Core::Hashable
# Specifies cloud audit logging configuration for this policy.
# Corresponds to the JSON property `auditConfigs`
# @return [Array<Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1AuditConfig>]
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::CloudprivatecatalogproducerV1beta1::GoogleIamV1Binding>]
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
# Request message for `SetIamPolicy` method.
class GoogleIamV1SetIamPolicyRequest
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::CloudprivatecatalogproducerV1beta1::GoogleIamV1Policy]
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
# Request message for `TestIamPermissions` method.
class GoogleIamV1TestIamPermissionsRequest
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 GoogleIamV1TestIamPermissionsResponse
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 request message for Operations.CancelOperation.
class GoogleLongrunningCancelOperationRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# The response message for Operations.ListOperations.
class GoogleLongrunningListOperationsResponse
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::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation>]
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
# This resource represents a long-running operation that is the result of a
# network API call.
class GoogleLongrunningOperation
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::CloudprivatecatalogproducerV1beta1::GoogleRpcStatus]
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 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 GoogleProtobufEmpty
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
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 GoogleRpcStatus
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
# Represents an expression text. Example:
# title: "User account presence"
# description: "Determines whether the request has a user account"
# expression: "size(request.user) > 0"
class GoogleTypeExpr
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
end
end
end