Autogenerated update (2020-10-15)

Update:
- admin_directory_v1
- analyticsdata_v1alpha
- billingbudgets_v1
- billingbudgets_v1beta1
- classroom_v1
- container_v1beta1
- content_v2
- displayvideo_v1
- monitoring_v3
- playablelocations_v3
- prod_tt_sasportal_v1alpha1
- youtube_partner_v1
- youtube_v3
This commit is contained in:
Google APIs committed 2020-10-15 00:39:14 +00:00
1 parent 3e4cb87c9a
commit 586c96fc01
36 files changed
+6965 -100

No files matched your search

+1 -1
View File
@@ -27,7 +27,7 @@ module Google
# @see http://developers.google.com/admin-sdk/
module AdminDirectoryV1
VERSION = 'DirectoryV1'
REVISION = '20200909'
REVISION = '20201013'
# View and manage customer related information
AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer'
@@ -1367,6 +1367,141 @@ module Google
end
end
# Information regarding a command that was issued to a device.
class DirectoryChromeosdevicesCommand
include Google::Apis::Core::Hashable
# The time at which the command will expire. If the device doesn't execute the
# command within this time the command will become expired.
# Corresponds to the JSON property `commandExpireTime`
# @return [String]
attr_accessor :command_expire_time
# Unique ID of a device command.
# Corresponds to the JSON property `commandId`
# @return [Fixnum]
attr_accessor :command_id
# The result of executing a command.
# Corresponds to the JSON property `commandResult`
# @return [Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesCommandResult]
attr_accessor :command_result
# The timestamp when the command was issued by the admin.
# Corresponds to the JSON property `issueTime`
# @return [String]
attr_accessor :issue_time
# The payload that the command specified, if any.
# Corresponds to the JSON property `payload`
# @return [String]
attr_accessor :payload
# Indicates the command state.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# The type of the command.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@command_expire_time = args[:command_expire_time] if args.key?(:command_expire_time)
@command_id = args[:command_id] if args.key?(:command_id)
@command_result = args[:command_result] if args.key?(:command_result)
@issue_time = args[:issue_time] if args.key?(:issue_time)
@payload = args[:payload] if args.key?(:payload)
@state = args[:state] if args.key?(:state)
@type = args[:type] if args.key?(:type)
end
end
# The result of executing a command.
class DirectoryChromeosdevicesCommandResult
include Google::Apis::Core::Hashable
# The error message with a short explanation as to why the command failed. Only
# present if the command failed.
# Corresponds to the JSON property `errorMessage`
# @return [String]
attr_accessor :error_message
# The time at which the command was executed or failed to execute.
# Corresponds to the JSON property `executeTime`
# @return [String]
attr_accessor :execute_time
# The result of the command.
# Corresponds to the JSON property `result`
# @return [String]
attr_accessor :result
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@error_message = args[:error_message] if args.key?(:error_message)
@execute_time = args[:execute_time] if args.key?(:execute_time)
@result = args[:result] if args.key?(:result)
end
end
# A request for issuing a command.
class DirectoryChromeosdevicesIssueCommandRequest
include Google::Apis::Core::Hashable
# The type of command.
# Corresponds to the JSON property `commandType`
# @return [String]
attr_accessor :command_type
# The payload for the command, provide it only if command supports it. The
# following commands support adding payload: - SET_VOLUME: Payload is a JSON
# object in the form: ` "volume": 50 `. The volume has to be an integer in the
# range [0,100].
# Corresponds to the JSON property `payload`
# @return [String]
attr_accessor :payload
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@command_type = args[:command_type] if args.key?(:command_type)
@payload = args[:payload] if args.key?(:payload)
end
end
# A response for issuing a command.
class DirectoryChromeosdevicesIssueCommandResponse
include Google::Apis::Core::Hashable
# The unique ID of the issued command, used to retrieve the command status.
# Corresponds to the JSON property `commandId`
# @return [Fixnum]
attr_accessor :command_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@command_id = args[:command_id] if args.key?(:command_id)
end
end
#
class DomainAlias
include Google::Apis::Core::Hashable
@@ -184,6 +184,30 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class DirectoryChromeosdevicesCommand
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DirectoryChromeosdevicesCommandResult
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DirectoryChromeosdevicesIssueCommandRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DirectoryChromeosdevicesIssueCommandResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DomainAlias
class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -857,6 +881,44 @@ module Google
end
end
class DirectoryChromeosdevicesCommand
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :command_expire_time, as: 'commandExpireTime'
property :command_id, :numeric_string => true, as: 'commandId'
property :command_result, as: 'commandResult', class: Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesCommandResult, decorator: Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesCommandResult::Representation
property :issue_time, as: 'issueTime'
property :payload, as: 'payload'
property :state, as: 'state'
property :type, as: 'type'
end
end
class DirectoryChromeosdevicesCommandResult
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :error_message, as: 'errorMessage'
property :execute_time, as: 'executeTime'
property :result, as: 'result'
end
end
class DirectoryChromeosdevicesIssueCommandRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :command_type, as: 'commandType'
property :payload, as: 'payload'
end
end
class DirectoryChromeosdevicesIssueCommandResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :command_id, :numeric_string => true, as: 'commandId'
end
end
class DomainAlias
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -409,6 +409,78 @@ module Google
execute_or_queue_command(command, &block)
end
# Issues a command for the device to execute.
# @param [String] customer_id
# Immutable. Immutable ID of the G Suite account.
# @param [String] device_id
# Immutable. Immutable ID of Chrome OS Device.
# @param [Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesIssueCommandRequest] directory_chromeosdevices_issue_command_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesIssueCommandResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesIssueCommandResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def issue_customer_device_chromeo_command(customer_id, device_id, directory_chromeosdevices_issue_command_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand', options)
command.request_representation = Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesIssueCommandRequest::Representation
command.request_object = directory_chromeosdevices_issue_command_request_object
command.response_representation = Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesIssueCommandResponse::Representation
command.response_class = Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesIssueCommandResponse
command.params['customerId'] = customer_id unless customer_id.nil?
command.params['deviceId'] = device_id unless device_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets command data a specific command issued to the device.
# @param [String] customer_id
# Immutable. Immutable ID of the G Suite account.
# @param [String] device_id
# Immutable. Immutable ID of Chrome OS Device.
# @param [Fixnum] command_id
# Immutable. Immutable ID of Chrome OS Device Command.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesCommand] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesCommand]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_customer_device_chromeo_command(customer_id, device_id, command_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}', options)
command.response_representation = Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesCommand::Representation
command.response_class = Google::Apis::AdminDirectoryV1::DirectoryChromeosdevicesCommand
command.params['customerId'] = customer_id unless customer_id.nil?
command.params['deviceId'] = device_id unless device_id.nil?
command.params['commandId'] = command_id unless command_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves a customer.
# @param [String] customer_key
# Id of the customer to be retrieved
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/analytics/trusted-testing/analytics-data/
module AnalyticsdataV1alpha
VERSION = 'V1alpha'
REVISION = '20201006'
REVISION = '20201013'
# View and manage your Google Analytics data
AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics'
@@ -527,7 +527,7 @@ module Google
class Entity
include Google::Apis::Core::Hashable
# A Google Analytics App + Web property id.
# A Google Analytics GA4 property id.
# Corresponds to the JSON property `propertyId`
# @return [String]
attr_accessor :property_id
@@ -49,16 +49,16 @@ module Google
# Returns metadata for dimensions and metrics available in reporting methods.
# Used to explore the dimensions and metrics. In this method, a Google Analytics
# App + Web Property Identifier is specified in the request, and the metadata
# response includes Custom dimensions and metrics as well as Universal metadata.
# For example if a custom metric with parameter name `levels_unlocked` is
# registered to a property, the Metadata response will contain `customEvent:
# levels_unlocked`. Universal metadata are dimensions and metrics applicable to
# any property such as `country` and `totalUsers`.
# GA4 Property Identifier is specified in the request, and the metadata response
# includes Custom dimensions and metrics as well as Universal metadata. For
# example if a custom metric with parameter name `levels_unlocked` is registered
# to a property, the Metadata response will contain `customEvent:levels_unlocked`
# . Universal metadata are dimensions and metrics applicable to any property
# such as `country` and `totalUsers`.
# @param [String] name
# Required. The resource name of the metadata to retrieve. This name field is
# specified in the URL path and not URL parameters. Property is a numeric Google
# Analytics App + Web Property identifier. Example: properties/1234/metadata
# Analytics GA4 Property identifier. Example: properties/1234/metadata
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
+1 -1
View File
@@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/billing/docs/how-to/budget-api-overview
module BillingbudgetsV1
VERSION = 'V1'
REVISION = '20200919'
REVISION = '20201012'
# View and manage your Google Cloud Platform billing accounts
AUTH_CLOUD_BILLING = 'https://www.googleapis.com/auth/cloud-billing'
@@ -326,7 +326,7 @@ module Google
class GoogleTypeMoney
include Google::Apis::Core::Hashable
# The 3-letter currency code defined in ISO 4217.
# The three-letter currency code defined in ISO 4217.
# Corresponds to the JSON property `currencyCode`
# @return [String]
attr_accessor :currency_code
@@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/billing/docs/how-to/budget-api-overview
module BillingbudgetsV1beta1
VERSION = 'V1beta1'
REVISION = '20200912'
REVISION = '20201012'
# View and manage your Google Cloud Platform billing accounts
AUTH_CLOUD_BILLING = 'https://www.googleapis.com/auth/cloud-billing'
@@ -381,7 +381,7 @@ module Google
class GoogleTypeMoney
include Google::Apis::Core::Hashable
# The 3-letter currency code defined in ISO 4217.
# The three-letter currency code defined in ISO 4217.
# Corresponds to the JSON property `currencyCode`
# @return [String]
attr_accessor :currency_code
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/classroom/
module ClassroomV1
VERSION = 'V1'
REVISION = '20200915'
REVISION = '20201012'
# View and manage announcements in Google Classroom
AUTH_CLASSROOM_ANNOUNCEMENTS = 'https://www.googleapis.com/auth/classroom.announcements'
+21 -21
View File
@@ -526,14 +526,14 @@ module Google
# @return [String]
attr_accessor :description
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
# and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent: * A full
# date, with non-zero year, month and day values * A month and day value, with a
# zero year, e.g. an anniversary * A year on its own, with zero month and day
# values * A year and month value, with a zero day, e.g. a credit card
# expiration date Related types are google.type.TimeOfDay and `google.protobuf.
# Timestamp`.
# Represents a whole or partial calendar date, such as a birthday. The time of
# day and time zone are either specified elsewhere or are insignificant. The
# date is relative to the Gregorian Calendar. This can represent one of the
# following: * A full date, with non-zero year, month, and day values * A month
# and day value, with a zero year, such as an anniversary * A year on its own,
# with zero month and day values * A year and month value, with a zero day, such
# as a credit card expiration date Related types are google.type.TimeOfDay and `
# google.protobuf.Timestamp`.
# Corresponds to the JSON property `dueDate`
# @return [Google::Apis::ClassroomV1::Date]
attr_accessor :due_date
@@ -768,31 +768,31 @@ module Google
end
end
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
# and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent: * A full
# date, with non-zero year, month and day values * A month and day value, with a
# zero year, e.g. an anniversary * A year on its own, with zero month and day
# values * A year and month value, with a zero day, e.g. a credit card
# expiration date Related types are google.type.TimeOfDay and `google.protobuf.
# Timestamp`.
# Represents a whole or partial calendar date, such as a birthday. The time of
# day and time zone are either specified elsewhere or are insignificant. The
# date is relative to the Gregorian Calendar. This can represent one of the
# following: * A full date, with non-zero year, month, and day values * A month
# and day value, with a zero year, such as an anniversary * A year on its own,
# with zero month and day values * A year and month value, with a zero day, such
# as a credit card expiration date Related types are google.type.TimeOfDay and `
# google.protobuf.Timestamp`.
class Date
include Google::Apis::Core::Hashable
# Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if
# specifying a year by itself or a year and month where the day is not
# significant.
# Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
# specify a year by itself or a year and month where the day isn't significant.
# Corresponds to the JSON property `day`
# @return [Fixnum]
attr_accessor :day
# Month of year. Must be from 1 to 12, or 0 if specifying a year without a month
# Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
# and day.
# Corresponds to the JSON property `month`
# @return [Fixnum]
attr_accessor :month
# Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
# Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
# year.
# Corresponds to the JSON property `year`
# @return [Fixnum]
attr_accessor :year
+1 -1
View File
@@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/container-engine/
module ContainerV1beta1
VERSION = 'V1beta1'
REVISION = '20200928'
REVISION = '20201007'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -645,7 +645,14 @@ module Google
attr_accessor :location
# The list of Google Compute Engine [zones](https://cloud.google.com/compute/
# docs/zones#available) in which the cluster's nodes should be located.
# docs/zones#available) in which the cluster's nodes should be located. This
# field provides a default value if [NodePool.Locations](https://cloud.google.
# com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.
# nodePools#NodePool.FIELDS.locations) are not specified during node pool
# creation. Warning: changing cluster locations will update the [NodePool.
# Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/
# projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node
# pools and will result in nodes being added and/or removed.
# Corresponds to the JSON property `locations`
# @return [Array<String>]
attr_accessor :locations
@@ -1053,9 +1060,9 @@ module Google
# The desired list of Google Compute Engine [zones](https://cloud.google.com/
# compute/docs/zones#available) in which the cluster's nodes should be located.
# Changing the locations a cluster is in will result in nodes being either
# created or removed from the cluster, depending on whether locations are being
# added or removed. This list must always include the cluster's primary zone.
# This list must always include the cluster's primary zone. Warning: changing
# cluster locations will update the locations of all node pools and will result
# in nodes being added and/or removed.
# Corresponds to the JSON property `desiredLocations`
# @return [Array<String>]
attr_accessor :desired_locations
@@ -2631,11 +2638,12 @@ module Google
# - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "
# instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-
# address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-
# setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" - "serial-port-logging-
# enable" Values are free-form strings, and only have meaning as interpreted by
# the image running in the instance. The only restriction placed on them is that
# each value's size must be less than or equal to 32 KB. The total size of all
# keys and values must be less than 512 KB.
# setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" The following keys are
# reserved for Windows nodes: - "serial-port-logging-enable" Values are free-
# form strings, and only have meaning as interpreted by the image running in the
# instance. The only restriction placed on them is that each value's size must
# be less than or equal to 32 KB. The total size of all keys and values must be
# less than 512 KB.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,String>]
attr_accessor :metadata
@@ -2876,7 +2884,11 @@ module Google
attr_accessor :instance_group_urls
# The list of Google Compute Engine [zones](https://cloud.google.com/compute/
# docs/zones#available) in which the NodePool's nodes should be located.
# docs/zones#available) in which the NodePool's nodes should be located. If this
# value is unspecified during node pool creation, the [Cluster.Locations](https:/
# /cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.
# clusters#Cluster.FIELDS.locations) value will be used, instead. Warning:
# changing node pool locations will result in nodes being added and/or removed.
# Corresponds to the JSON property `locations`
# @return [Array<String>]
attr_accessor :locations
+1 -1
View File
@@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/shopping-content
module ContentV2
VERSION = 'V2'
REVISION = '20201007'
REVISION = '20201014'
# Manage your product listings and accounts for Google Shopping
AUTH_CONTENT = 'https://www.googleapis.com/auth/content'
+1 -1
View File
@@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/display-video/
module DisplayvideoV1
VERSION = 'V1'
REVISION = '20201006'
REVISION = '20201013'
# Create, see, edit, and permanently delete your Display & Video 360 entities and reports
AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video'
@@ -3113,31 +3113,31 @@ module Google
end
end
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
# and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent: * A full
# date, with non-zero year, month and day values * A month and day value, with a
# zero year, e.g. an anniversary * A year on its own, with zero month and day
# values * A year and month value, with a zero day, e.g. a credit card
# expiration date Related types are google.type.TimeOfDay and `google.protobuf.
# Timestamp`.
# Represents a whole or partial calendar date, such as a birthday. The time of
# day and time zone are either specified elsewhere or are insignificant. The
# date is relative to the Gregorian Calendar. This can represent one of the
# following: * A full date, with non-zero year, month, and day values * A month
# and day value, with a zero year, such as an anniversary * A year on its own,
# with zero month and day values * A year and month value, with a zero day, such
# as a credit card expiration date Related types are google.type.TimeOfDay and `
# google.protobuf.Timestamp`.
class Date
include Google::Apis::Core::Hashable
# Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if
# specifying a year by itself or a year and month where the day is not
# significant.
# Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
# specify a year by itself or a year and month where the day isn't significant.
# Corresponds to the JSON property `day`
# @return [Fixnum]
attr_accessor :day
# Month of year. Must be from 1 to 12, or 0 if specifying a year without a month
# Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
# and day.
# Corresponds to the JSON property `month`
# @return [Fixnum]
attr_accessor :month
# Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
# Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
# year.
# Corresponds to the JSON property `year`
# @return [Fixnum]
attr_accessor :year
@@ -3158,26 +3158,26 @@ module Google
class DateRange
include Google::Apis::Core::Hashable
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
# and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent: * A full
# date, with non-zero year, month and day values * A month and day value, with a
# zero year, e.g. an anniversary * A year on its own, with zero month and day
# values * A year and month value, with a zero day, e.g. a credit card
# expiration date Related types are google.type.TimeOfDay and `google.protobuf.
# Timestamp`.
# Represents a whole or partial calendar date, such as a birthday. The time of
# day and time zone are either specified elsewhere or are insignificant. The
# date is relative to the Gregorian Calendar. This can represent one of the
# following: * A full date, with non-zero year, month, and day values * A month
# and day value, with a zero year, such as an anniversary * A year on its own,
# with zero month and day values * A year and month value, with a zero day, such
# as a credit card expiration date Related types are google.type.TimeOfDay and `
# google.protobuf.Timestamp`.
# Corresponds to the JSON property `endDate`
# @return [Google::Apis::DisplayvideoV1::Date]
attr_accessor :end_date
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
# and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent: * A full
# date, with non-zero year, month and day values * A month and day value, with a
# zero year, e.g. an anniversary * A year on its own, with zero month and day
# values * A year and month value, with a zero day, e.g. a credit card
# expiration date Related types are google.type.TimeOfDay and `google.protobuf.
# Timestamp`.
# Represents a whole or partial calendar date, such as a birthday. The time of
# day and time zone are either specified elsewhere or are insignificant. The
# date is relative to the Gregorian Calendar. This can represent one of the
# following: * A full date, with non-zero year, month, and day values * A month
# and day value, with a zero year, such as an anniversary * A year on its own,
# with zero month and day values * A year and month value, with a zero day, such
# as a credit card expiration date Related types are google.type.TimeOfDay and `
# google.protobuf.Timestamp`.
# Corresponds to the JSON property `startDate`
# @return [Google::Apis::DisplayvideoV1::Date]
attr_accessor :start_date
@@ -6242,7 +6242,7 @@ module Google
class Money
include Google::Apis::Core::Hashable
# The 3-letter currency code defined in ISO 4217.
# The three-letter currency code defined in ISO 4217.
# Corresponds to the JSON property `currencyCode`
# @return [String]
attr_accessor :currency_code
+34
View File
@@ -0,0 +1,34 @@
# 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 'google/apis/domains_v1alpha2/service.rb'
require 'google/apis/domains_v1alpha2/classes.rb'
require 'google/apis/domains_v1alpha2/representations.rb'
module Google
module Apis
# Cloud Domains API
#
# Enables management and configuration of domain names.
#
# @see https://cloud.google.com/domains/
module DomainsV1alpha2
VERSION = 'V1alpha2'
REVISION = '20201013'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
end
end
end
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,605 @@
# 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 DomainsV1alpha2
class AuditConfig
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AuditLogConfig
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AuthorizationCode
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Binding
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ConfigureContactSettingsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ConfigureDnsSettingsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ConfigureManagementSettingsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Contact
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ContactSettings
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CustomDns
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DnsSettings
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DsRecord
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ExportRegistrationRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Expr
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GlueRecord
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleDomainsDns
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListLocationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListOperationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListRegistrationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Location
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ManagementSettings
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Money
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Operation
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class OperationMetadata
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Policy
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class PostalAddress
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RegisterDomainRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RegisterParameters
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Registration
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ResetAuthorizationCodeRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RetrieveRegisterParametersResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SearchDomainsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SetIamPolicyRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Status
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TestIamPermissionsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TestIamPermissionsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AuditConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::DomainsV1alpha2::AuditLogConfig, decorator: Google::Apis::DomainsV1alpha2::AuditLogConfig::Representation
property :service, as: 'service'
end
end
class AuditLogConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :exempted_members, as: 'exemptedMembers'
property :log_type, as: 'logType'
end
end
class AuthorizationCode
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
end
end
class Binding
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :condition, as: 'condition', class: Google::Apis::DomainsV1alpha2::Expr, decorator: Google::Apis::DomainsV1alpha2::Expr::Representation
collection :members, as: 'members'
property :role, as: 'role'
end
end
class ConfigureContactSettingsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :contact_notices, as: 'contactNotices'
property :contact_settings, as: 'contactSettings', class: Google::Apis::DomainsV1alpha2::ContactSettings, decorator: Google::Apis::DomainsV1alpha2::ContactSettings::Representation
property :update_mask, as: 'updateMask'
property :validate_only, as: 'validateOnly'
end
end
class ConfigureDnsSettingsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :dns_settings, as: 'dnsSettings', class: Google::Apis::DomainsV1alpha2::DnsSettings, decorator: Google::Apis::DomainsV1alpha2::DnsSettings::Representation
property :update_mask, as: 'updateMask'
property :validate_only, as: 'validateOnly'
end
end
class ConfigureManagementSettingsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :management_settings, as: 'managementSettings', class: Google::Apis::DomainsV1alpha2::ManagementSettings, decorator: Google::Apis::DomainsV1alpha2::ManagementSettings::Representation
property :update_mask, as: 'updateMask'
end
end
class Contact
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :email, as: 'email'
property :fax_number, as: 'faxNumber'
property :phone_number, as: 'phoneNumber'
property :postal_address, as: 'postalAddress', class: Google::Apis::DomainsV1alpha2::PostalAddress, decorator: Google::Apis::DomainsV1alpha2::PostalAddress::Representation
end
end
class ContactSettings
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :admin_contact, as: 'adminContact', class: Google::Apis::DomainsV1alpha2::Contact, decorator: Google::Apis::DomainsV1alpha2::Contact::Representation
property :privacy, as: 'privacy'
property :registrant_contact, as: 'registrantContact', class: Google::Apis::DomainsV1alpha2::Contact, decorator: Google::Apis::DomainsV1alpha2::Contact::Representation
property :technical_contact, as: 'technicalContact', class: Google::Apis::DomainsV1alpha2::Contact, decorator: Google::Apis::DomainsV1alpha2::Contact::Representation
end
end
class CustomDns
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :ds_records, as: 'dsRecords', class: Google::Apis::DomainsV1alpha2::DsRecord, decorator: Google::Apis::DomainsV1alpha2::DsRecord::Representation
collection :name_servers, as: 'nameServers'
end
end
class DnsSettings
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :custom_dns, as: 'customDns', class: Google::Apis::DomainsV1alpha2::CustomDns, decorator: Google::Apis::DomainsV1alpha2::CustomDns::Representation
collection :glue_records, as: 'glueRecords', class: Google::Apis::DomainsV1alpha2::GlueRecord, decorator: Google::Apis::DomainsV1alpha2::GlueRecord::Representation
property :google_domains_dns, as: 'googleDomainsDns', class: Google::Apis::DomainsV1alpha2::GoogleDomainsDns, decorator: Google::Apis::DomainsV1alpha2::GoogleDomainsDns::Representation
end
end
class DsRecord
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :algorithm, as: 'algorithm'
property :digest, as: 'digest'
property :digest_type, as: 'digestType'
property :key_tag, as: 'keyTag'
end
end
class ExportRegistrationRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class Expr
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :description, as: 'description'
property :expression, as: 'expression'
property :location, as: 'location'
property :title, as: 'title'
end
end
class GlueRecord
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :host_name, as: 'hostName'
collection :ipv4_addresses, as: 'ipv4Addresses'
collection :ipv6_addresses, as: 'ipv6Addresses'
end
end
class GoogleDomainsDns
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :ds_records, as: 'dsRecords', class: Google::Apis::DomainsV1alpha2::DsRecord, decorator: Google::Apis::DomainsV1alpha2::DsRecord::Representation
property :ds_state, as: 'dsState'
collection :name_servers, as: 'nameServers'
end
end
class ListLocationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :locations, as: 'locations', class: Google::Apis::DomainsV1alpha2::Location, decorator: Google::Apis::DomainsV1alpha2::Location::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class ListOperationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :operations, as: 'operations', class: Google::Apis::DomainsV1alpha2::Operation, decorator: Google::Apis::DomainsV1alpha2::Operation::Representation
end
end
class ListRegistrationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :registrations, as: 'registrations', class: Google::Apis::DomainsV1alpha2::Registration, decorator: Google::Apis::DomainsV1alpha2::Registration::Representation
end
end
class Location
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :display_name, as: 'displayName'
hash :labels, as: 'labels'
property :location_id, as: 'locationId'
hash :metadata, as: 'metadata'
property :name, as: 'name'
end
end
class ManagementSettings
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :renewal_method, as: 'renewalMethod'
property :transfer_lock_state, as: 'transferLockState'
end
end
class Money
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :currency_code, as: 'currencyCode'
property :nanos, as: 'nanos'
property :units, :numeric_string => true, as: 'units'
end
end
class Operation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :done, as: 'done'
property :error, as: 'error', class: Google::Apis::DomainsV1alpha2::Status, decorator: Google::Apis::DomainsV1alpha2::Status::Representation
hash :metadata, as: 'metadata'
property :name, as: 'name'
hash :response, as: 'response'
end
end
class OperationMetadata
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :api_version, as: 'apiVersion'
property :create_time, as: 'createTime'
property :end_time, as: 'endTime'
property :status_detail, as: 'statusDetail'
property :target, as: 'target'
property :verb, as: 'verb'
end
end
class Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :audit_configs, as: 'auditConfigs', class: Google::Apis::DomainsV1alpha2::AuditConfig, decorator: Google::Apis::DomainsV1alpha2::AuditConfig::Representation
collection :bindings, as: 'bindings', class: Google::Apis::DomainsV1alpha2::Binding, decorator: Google::Apis::DomainsV1alpha2::Binding::Representation
property :etag, :base64 => true, as: 'etag'
property :version, as: 'version'
end
end
class PostalAddress
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :address_lines, as: 'addressLines'
property :administrative_area, as: 'administrativeArea'
property :language_code, as: 'languageCode'
property :locality, as: 'locality'
property :organization, as: 'organization'
property :postal_code, as: 'postalCode'
collection :recipients, as: 'recipients'
property :region_code, as: 'regionCode'
property :revision, as: 'revision'
property :sorting_code, as: 'sortingCode'
property :sublocality, as: 'sublocality'
end
end
class RegisterDomainRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :contact_notices, as: 'contactNotices'
collection :domain_notices, as: 'domainNotices'
property :registration, as: 'registration', class: Google::Apis::DomainsV1alpha2::Registration, decorator: Google::Apis::DomainsV1alpha2::Registration::Representation
property :validate_only, as: 'validateOnly'
property :yearly_price, as: 'yearlyPrice', class: Google::Apis::DomainsV1alpha2::Money, decorator: Google::Apis::DomainsV1alpha2::Money::Representation
end
end
class RegisterParameters
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :availability, as: 'availability'
property :domain_name, as: 'domainName'
collection :domain_notices, as: 'domainNotices'
collection :supported_privacy, as: 'supportedPrivacy'
property :yearly_price, as: 'yearlyPrice', class: Google::Apis::DomainsV1alpha2::Money, decorator: Google::Apis::DomainsV1alpha2::Money::Representation
end
end
class Registration
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :contact_settings, as: 'contactSettings', class: Google::Apis::DomainsV1alpha2::ContactSettings, decorator: Google::Apis::DomainsV1alpha2::ContactSettings::Representation
property :create_time, as: 'createTime'
property :dns_settings, as: 'dnsSettings', class: Google::Apis::DomainsV1alpha2::DnsSettings, decorator: Google::Apis::DomainsV1alpha2::DnsSettings::Representation
property :domain_name, as: 'domainName'
property :expire_time, as: 'expireTime'
collection :issues, as: 'issues'
hash :labels, as: 'labels'
property :management_settings, as: 'managementSettings', class: Google::Apis::DomainsV1alpha2::ManagementSettings, decorator: Google::Apis::DomainsV1alpha2::ManagementSettings::Representation
property :name, as: 'name'
property :pending_contact_settings, as: 'pendingContactSettings', class: Google::Apis::DomainsV1alpha2::ContactSettings, decorator: Google::Apis::DomainsV1alpha2::ContactSettings::Representation
property :state, as: 'state'
collection :supported_privacy, as: 'supportedPrivacy'
end
end
class ResetAuthorizationCodeRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class RetrieveRegisterParametersResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :register_parameters, as: 'registerParameters', class: Google::Apis::DomainsV1alpha2::RegisterParameters, decorator: Google::Apis::DomainsV1alpha2::RegisterParameters::Representation
end
end
class SearchDomainsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :register_parameters, as: 'registerParameters', class: Google::Apis::DomainsV1alpha2::RegisterParameters, decorator: Google::Apis::DomainsV1alpha2::RegisterParameters::Representation
end
end
class SetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :policy, as: 'policy', class: Google::Apis::DomainsV1alpha2::Policy, decorator: Google::Apis::DomainsV1alpha2::Policy::Representation
property :update_mask, as: 'updateMask'
end
end
class Status
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
collection :details, as: 'details'
property :message, as: 'message'
end
end
class TestIamPermissionsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
end
end
class TestIamPermissionsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
end
end
end
end
end
@@ -0,0 +1,805 @@
# 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 '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 DomainsV1alpha2
# Cloud Domains API
#
# Enables management and configuration of domain names.
#
# @example
# require 'google/apis/domains_v1alpha2'
#
# Domains = Google::Apis::DomainsV1alpha2 # Alias the module
# service = Domains::CloudDomainsService.new
#
# @see https://cloud.google.com/domains/
class CloudDomainsService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://domains.googleapis.com/', '')
@batch_path = 'batch'
end
# Gets information about a location.
# @param [String] name
# Resource name for the location.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::Location] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::Location]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
command.response_representation = Google::Apis::DomainsV1alpha2::Location::Representation
command.response_class = Google::Apis::DomainsV1alpha2::Location
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists information about the supported locations for this service.
# @param [String] name
# The resource that owns the locations collection, if applicable.
# @param [String] filter
# The standard list filter.
# @param [Fixnum] page_size
# The standard list page size.
# @param [String] page_token
# The standard list page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::ListLocationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::ListLocationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1alpha2/{+name}/locations', options)
command.response_representation = Google::Apis::DomainsV1alpha2::ListLocationsResponse::Representation
command.response_class = Google::Apis::DomainsV1alpha2::ListLocationsResponse
command.params['name'] = name unless name.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the latest state of a long-running operation. Clients can use this method
# to poll the operation result at intervals as recommended by the API service.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
command.response_class = Google::Apis::DomainsV1alpha2::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists operations that match the specified filter in the request. If the server
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
# binding allows API services to override the binding to use different resource
# name schemes, such as `users/*/operations`. To override the binding, API
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
# service configuration. For backwards compatibility, the default name includes
# the operations collection id, however overriding users must ensure the name
# binding is the parent resource, without the operations collection id.
# @param [String] name
# The name of the operation's parent resource.
# @param [String] filter
# The standard list filter.
# @param [Fixnum] page_size
# The standard list page size.
# @param [String] page_token
# The standard list page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::ListOperationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::ListOperationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1alpha2/{+name}/operations', options)
command.response_representation = Google::Apis::DomainsV1alpha2::ListOperationsResponse::Representation
command.response_class = Google::Apis::DomainsV1alpha2::ListOperationsResponse
command.params['name'] = name unless name.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a `Registration`'s contact settings. Some changes require confirmation
# by the domain's registrant contact .
# @param [String] registration
# Required. The name of the `Registration` whose contact settings are being
# updated, in the format `projects/*/locations/*/registrations/*`.
# @param [Google::Apis::DomainsV1alpha2::ConfigureContactSettingsRequest] configure_contact_settings_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def configure_registration_contact_settings(registration, configure_contact_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1alpha2/{+registration}:configureContactSettings', options)
command.request_representation = Google::Apis::DomainsV1alpha2::ConfigureContactSettingsRequest::Representation
command.request_object = configure_contact_settings_request_object
command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
command.response_class = Google::Apis::DomainsV1alpha2::Operation
command.params['registration'] = registration unless registration.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a `Registration`'s DNS settings.
# @param [String] registration
# Required. The name of the `Registration` whose DNS settings are being updated,
# in the format `projects/*/locations/*/registrations/*`.
# @param [Google::Apis::DomainsV1alpha2::ConfigureDnsSettingsRequest] configure_dns_settings_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def configure_registration_dns_settings(registration, configure_dns_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1alpha2/{+registration}:configureDnsSettings', options)
command.request_representation = Google::Apis::DomainsV1alpha2::ConfigureDnsSettingsRequest::Representation
command.request_object = configure_dns_settings_request_object
command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
command.response_class = Google::Apis::DomainsV1alpha2::Operation
command.params['registration'] = registration unless registration.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a `Registration`'s management settings.
# @param [String] registration
# Required. The name of the `Registration` whose management settings are being
# updated, in the format `projects/*/locations/*/registrations/*`.
# @param [Google::Apis::DomainsV1alpha2::ConfigureManagementSettingsRequest] configure_management_settings_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def configure_registration_management_settings(registration, configure_management_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1alpha2/{+registration}:configureManagementSettings', options)
command.request_representation = Google::Apis::DomainsV1alpha2::ConfigureManagementSettingsRequest::Representation
command.request_object = configure_management_settings_request_object
command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
command.response_class = Google::Apis::DomainsV1alpha2::Operation
command.params['registration'] = registration unless registration.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a `Registration` resource. This method only works on resources in one
# of the following states: * `state` is `EXPORTED` with `expire_time` in the
# past * `state` is `REGISTRATION_FAILED`
# @param [String] name
# Required. The name of the `Registration` to delete, in the format `projects/*/
# locations/*/registrations/*`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_location_registration(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
command.response_class = Google::Apis::DomainsV1alpha2::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Exports a `Registration` that you no longer want to use with Cloud Domains.
# You can continue to use the domain in [Google Domains](https://domains.google/)
# until it expires. If the export is successful: * The resource's `state`
# becomes `EXPORTED`, meaning that it is no longer managed by Cloud Domains *
# Because individual users can own domains in Google Domains, the calling user
# becomes the domain's sole owner. Permissions for the domain are subsequently
# managed in Google Domains. * Without further action, the domain does not renew
# automatically. The new owner can set up billing in Google Domains to renew the
# domain if needed.
# @param [String] name
# Required. The name of the `Registration` to export, in the format `projects/*/
# locations/*/registrations/*`.
# @param [Google::Apis::DomainsV1alpha2::ExportRegistrationRequest] export_registration_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def export_registration(name, export_registration_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1alpha2/{+name}:export', options)
command.request_representation = Google::Apis::DomainsV1alpha2::ExportRegistrationRequest::Representation
command.request_object = export_registration_request_object
command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
command.response_class = Google::Apis::DomainsV1alpha2::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the details of a `Registration` resource.
# @param [String] name
# Required. The name of the `Registration` to get, in the format `projects/*/
# locations/*/registrations/*`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::Registration] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::Registration]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_registration(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
command.response_representation = Google::Apis::DomainsV1alpha2::Registration::Representation
command.response_class = Google::Apis::DomainsV1alpha2::Registration
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The policy format version to be returned. Valid values are 0, 1, and
# 3. Requests specifying an invalid value will be rejected. Requests for
# policies with any conditional bindings must specify version 3. Policies
# without any conditional bindings may specify any valid value or leave the
# field unset. To learn which resources support conditions in their IAM policies,
# see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
# resource-policies).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_registration_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::DomainsV1alpha2::Policy::Representation
command.response_class = Google::Apis::DomainsV1alpha2::Policy
command.params['resource'] = resource unless resource.nil?
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the `Registration` resources in a project.
# @param [String] parent
# Required. The project and location from which to list `Registration`s,
# specified in the format `projects/*/locations/*`.
# @param [String] filter
# Filter expression to restrict the `Registration`s returned. The expression
# must specify the field name, a comparison operator, and the value that you
# want to use for filtering. The value must be a string, a number, a boolean, or
# an enum value. The comparison operator should be one of =, !=, >, <, >=, <=,
# or : for prefix or wildcard matches. For example, to filter to a specific
# domain name, use an expression like `domainName="example.com"`. You can also
# check for the existence of a field; for example, to find domains using custom
# DNS settings, use an expression like `dnsSettings.customDns:*`. You can also
# create compound filters by combining expressions with the `AND` and `OR`
# operators. For example, to find domains that are suspended or have specific
# issues flagged, use an expression like `(state=SUSPENDED) OR (issue:*)`.
# @param [Fixnum] page_size
# Maximum number of results to return.
# @param [String] page_token
# When set to the `next_page_token` from a prior response, provides the next
# page of results.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::ListRegistrationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::ListRegistrationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_registrations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1alpha2/{+parent}/registrations', options)
command.response_representation = Google::Apis::DomainsV1alpha2::ListRegistrationsResponse::Representation
command.response_class = Google::Apis::DomainsV1alpha2::ListRegistrationsResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates select fields of a `Registration` resource, notably `labels`. To
# update other fields, use the appropriate custom update method: * To update
# management settings, see `ConfigureManagementSettings` * To update DNS
# configuration, see `ConfigureDnsSettings` * To update contact information, see
# `ConfigureContactSettings`
# @param [String] name
# Output only. Name of the `Registration` resource, in the format `projects/*/
# locations/*/registrations/`.
# @param [Google::Apis::DomainsV1alpha2::Registration] registration_object
# @param [String] update_mask
# Required. The field mask describing which fields to update as a comma-
# separated list. For example, if only the labels are being updated, the `
# update_mask` would be `"labels"`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_location_registration(name, registration_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
command.request_representation = Google::Apis::DomainsV1alpha2::Registration::Representation
command.request_object = registration_object
command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
command.response_class = Google::Apis::DomainsV1alpha2::Operation
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Registers a new domain name and creates a corresponding `Registration`
# resource. Call `RetrieveRegisterParameters` first to check availability of the
# domain name and determine parameters like price that are needed to build a
# call to this method. A successful call creates a `Registration` resource in
# state `REGISTRATION_PENDING`, which resolves to `ACTIVE` within 1-2 minutes,
# indicating that the domain was successfully registered. If the resource ends
# up in state `REGISTRATION_FAILED`, it indicates that the domain was not
# registered successfully, and you can safely delete the resource and retry
# registration.
# @param [String] parent
# Required. The parent resource of the `Registration`. Must be in the format `
# projects/*/locations/*`.
# @param [Google::Apis::DomainsV1alpha2::RegisterDomainRequest] register_domain_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def register_registration_domain(parent, register_domain_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1alpha2/{+parent}/registrations:register', options)
command.request_representation = Google::Apis::DomainsV1alpha2::RegisterDomainRequest::Representation
command.request_object = register_domain_request_object
command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
command.response_class = Google::Apis::DomainsV1alpha2::Operation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Resets the authorization code of the `Registration` to a new random string.
# You can call this method only after 60 days have elapsed since the initial
# domain registration.
# @param [String] registration
# Required. The name of the `Registration` whose authorization code is being
# reset, in the format `projects/*/locations/*/registrations/*`.
# @param [Google::Apis::DomainsV1alpha2::ResetAuthorizationCodeRequest] reset_authorization_code_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::AuthorizationCode] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::AuthorizationCode]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def reset_registration_authorization_code(registration, reset_authorization_code_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1alpha2/{+registration}:resetAuthorizationCode', options)
command.request_representation = Google::Apis::DomainsV1alpha2::ResetAuthorizationCodeRequest::Representation
command.request_object = reset_authorization_code_request_object
command.response_representation = Google::Apis::DomainsV1alpha2::AuthorizationCode::Representation
command.response_class = Google::Apis::DomainsV1alpha2::AuthorizationCode
command.params['registration'] = registration unless registration.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the authorization code of the `Registration` for the purpose of
# transferring the domain to another registrar. You can call this method only
# after 60 days have elapsed since the initial domain registration.
# @param [String] registration
# Required. The name of the `Registration` whose authorization code is being
# retrieved, in the format `projects/*/locations/*/registrations/*`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::AuthorizationCode] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::AuthorizationCode]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def retrieve_project_location_registration_authorization_code(registration, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1alpha2/{+registration}:retrieveAuthorizationCode', options)
command.response_representation = Google::Apis::DomainsV1alpha2::AuthorizationCode::Representation
command.response_class = Google::Apis::DomainsV1alpha2::AuthorizationCode
command.params['registration'] = registration unless registration.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets parameters needed to register a new domain name, including price and up-
# to-date availability. Use the returned values to call `RegisterDomain`.
# @param [String] location
# Required. The location. Must be in the format `projects/*/locations/*`.
# @param [String] domain_name
# Required. The domain name. Unicode domain names must be expressed in Punycode
# format.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::RetrieveRegisterParametersResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::RetrieveRegisterParametersResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def retrieve_project_location_registration_register_parameters(location, domain_name: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1alpha2/{+location}/registrations:retrieveRegisterParameters', options)
command.response_representation = Google::Apis::DomainsV1alpha2::RetrieveRegisterParametersResponse::Representation
command.response_class = Google::Apis::DomainsV1alpha2::RetrieveRegisterParametersResponse
command.params['location'] = location unless location.nil?
command.query['domainName'] = domain_name unless domain_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Searches for available domain names similar to the provided query.
# Availability results from this method are approximate; call `
# RetrieveRegisterParameters` on a domain before registering to confirm
# availability.
# @param [String] location
# Required. The location. Must be in the format `projects/*/locations/*`.
# @param [String] query
# Required. String used to search for available domain names.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::SearchDomainsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::SearchDomainsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def search_project_location_registration_domains(location, query: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1alpha2/{+location}/registrations:searchDomains', options)
command.response_representation = Google::Apis::DomainsV1alpha2::SearchDomainsResponse::Representation
command.response_class = Google::Apis::DomainsV1alpha2::SearchDomainsResponse
command.params['location'] = location unless location.nil?
command.query['query'] = query unless query.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
# PERMISSION_DENIED` errors.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DomainsV1alpha2::SetIamPolicyRequest] set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_registration_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::DomainsV1alpha2::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::DomainsV1alpha2::Policy::Representation
command.response_class = Google::Apis::DomainsV1alpha2::Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified resource. If the
# resource does not exist, this will return an empty set of permissions, not a `
# NOT_FOUND` error. Note: This operation is designed to be used for building
# permission-aware UIs and command-line tools, not for authorization checking.
# This operation may "fail open" without warning.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DomainsV1alpha2::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1alpha2::TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1alpha2::TestIamPermissionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_registration_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::DomainsV1alpha2::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::DomainsV1alpha2::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::DomainsV1alpha2::TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
+34
View File
@@ -0,0 +1,34 @@
# 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 'google/apis/domains_v1beta1/service.rb'
require 'google/apis/domains_v1beta1/classes.rb'
require 'google/apis/domains_v1beta1/representations.rb'
module Google
module Apis
# Cloud Domains API
#
# Enables management and configuration of domain names.
#
# @see https://cloud.google.com/domains/
module DomainsV1beta1
VERSION = 'V1beta1'
REVISION = '20201013'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
end
end
end
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,605 @@
# 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 DomainsV1beta1
class AuditConfig
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AuditLogConfig
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AuthorizationCode
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Binding
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ConfigureContactSettingsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ConfigureDnsSettingsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ConfigureManagementSettingsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Contact
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ContactSettings
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CustomDns
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DnsSettings
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DsRecord
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ExportRegistrationRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Expr
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GlueRecord
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleDomainsDns
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListLocationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListOperationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListRegistrationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Location
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ManagementSettings
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Money
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Operation
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class OperationMetadata
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Policy
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class PostalAddress
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RegisterDomainRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RegisterParameters
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Registration
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ResetAuthorizationCodeRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RetrieveRegisterParametersResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SearchDomainsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SetIamPolicyRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Status
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TestIamPermissionsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TestIamPermissionsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AuditConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::DomainsV1beta1::AuditLogConfig, decorator: Google::Apis::DomainsV1beta1::AuditLogConfig::Representation
property :service, as: 'service'
end
end
class AuditLogConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :exempted_members, as: 'exemptedMembers'
property :log_type, as: 'logType'
end
end
class AuthorizationCode
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
end
end
class Binding
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :condition, as: 'condition', class: Google::Apis::DomainsV1beta1::Expr, decorator: Google::Apis::DomainsV1beta1::Expr::Representation
collection :members, as: 'members'
property :role, as: 'role'
end
end
class ConfigureContactSettingsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :contact_notices, as: 'contactNotices'
property :contact_settings, as: 'contactSettings', class: Google::Apis::DomainsV1beta1::ContactSettings, decorator: Google::Apis::DomainsV1beta1::ContactSettings::Representation
property :update_mask, as: 'updateMask'
property :validate_only, as: 'validateOnly'
end
end
class ConfigureDnsSettingsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :dns_settings, as: 'dnsSettings', class: Google::Apis::DomainsV1beta1::DnsSettings, decorator: Google::Apis::DomainsV1beta1::DnsSettings::Representation
property :update_mask, as: 'updateMask'
property :validate_only, as: 'validateOnly'
end
end
class ConfigureManagementSettingsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :management_settings, as: 'managementSettings', class: Google::Apis::DomainsV1beta1::ManagementSettings, decorator: Google::Apis::DomainsV1beta1::ManagementSettings::Representation
property :update_mask, as: 'updateMask'
end
end
class Contact
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :email, as: 'email'
property :fax_number, as: 'faxNumber'
property :phone_number, as: 'phoneNumber'
property :postal_address, as: 'postalAddress', class: Google::Apis::DomainsV1beta1::PostalAddress, decorator: Google::Apis::DomainsV1beta1::PostalAddress::Representation
end
end
class ContactSettings
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :admin_contact, as: 'adminContact', class: Google::Apis::DomainsV1beta1::Contact, decorator: Google::Apis::DomainsV1beta1::Contact::Representation
property :privacy, as: 'privacy'
property :registrant_contact, as: 'registrantContact', class: Google::Apis::DomainsV1beta1::Contact, decorator: Google::Apis::DomainsV1beta1::Contact::Representation
property :technical_contact, as: 'technicalContact', class: Google::Apis::DomainsV1beta1::Contact, decorator: Google::Apis::DomainsV1beta1::Contact::Representation
end
end
class CustomDns
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :ds_records, as: 'dsRecords', class: Google::Apis::DomainsV1beta1::DsRecord, decorator: Google::Apis::DomainsV1beta1::DsRecord::Representation
collection :name_servers, as: 'nameServers'
end
end
class DnsSettings
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :custom_dns, as: 'customDns', class: Google::Apis::DomainsV1beta1::CustomDns, decorator: Google::Apis::DomainsV1beta1::CustomDns::Representation
collection :glue_records, as: 'glueRecords', class: Google::Apis::DomainsV1beta1::GlueRecord, decorator: Google::Apis::DomainsV1beta1::GlueRecord::Representation
property :google_domains_dns, as: 'googleDomainsDns', class: Google::Apis::DomainsV1beta1::GoogleDomainsDns, decorator: Google::Apis::DomainsV1beta1::GoogleDomainsDns::Representation
end
end
class DsRecord
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :algorithm, as: 'algorithm'
property :digest, as: 'digest'
property :digest_type, as: 'digestType'
property :key_tag, as: 'keyTag'
end
end
class ExportRegistrationRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class Expr
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :description, as: 'description'
property :expression, as: 'expression'
property :location, as: 'location'
property :title, as: 'title'
end
end
class GlueRecord
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :host_name, as: 'hostName'
collection :ipv4_addresses, as: 'ipv4Addresses'
collection :ipv6_addresses, as: 'ipv6Addresses'
end
end
class GoogleDomainsDns
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :ds_records, as: 'dsRecords', class: Google::Apis::DomainsV1beta1::DsRecord, decorator: Google::Apis::DomainsV1beta1::DsRecord::Representation
property :ds_state, as: 'dsState'
collection :name_servers, as: 'nameServers'
end
end
class ListLocationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :locations, as: 'locations', class: Google::Apis::DomainsV1beta1::Location, decorator: Google::Apis::DomainsV1beta1::Location::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class ListOperationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :operations, as: 'operations', class: Google::Apis::DomainsV1beta1::Operation, decorator: Google::Apis::DomainsV1beta1::Operation::Representation
end
end
class ListRegistrationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :registrations, as: 'registrations', class: Google::Apis::DomainsV1beta1::Registration, decorator: Google::Apis::DomainsV1beta1::Registration::Representation
end
end
class Location
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :display_name, as: 'displayName'
hash :labels, as: 'labels'
property :location_id, as: 'locationId'
hash :metadata, as: 'metadata'
property :name, as: 'name'
end
end
class ManagementSettings
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :renewal_method, as: 'renewalMethod'
property :transfer_lock_state, as: 'transferLockState'
end
end
class Money
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :currency_code, as: 'currencyCode'
property :nanos, as: 'nanos'
property :units, :numeric_string => true, as: 'units'
end
end
class Operation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :done, as: 'done'
property :error, as: 'error', class: Google::Apis::DomainsV1beta1::Status, decorator: Google::Apis::DomainsV1beta1::Status::Representation
hash :metadata, as: 'metadata'
property :name, as: 'name'
hash :response, as: 'response'
end
end
class OperationMetadata
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :api_version, as: 'apiVersion'
property :create_time, as: 'createTime'
property :end_time, as: 'endTime'
property :status_detail, as: 'statusDetail'
property :target, as: 'target'
property :verb, as: 'verb'
end
end
class Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :audit_configs, as: 'auditConfigs', class: Google::Apis::DomainsV1beta1::AuditConfig, decorator: Google::Apis::DomainsV1beta1::AuditConfig::Representation
collection :bindings, as: 'bindings', class: Google::Apis::DomainsV1beta1::Binding, decorator: Google::Apis::DomainsV1beta1::Binding::Representation
property :etag, :base64 => true, as: 'etag'
property :version, as: 'version'
end
end
class PostalAddress
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :address_lines, as: 'addressLines'
property :administrative_area, as: 'administrativeArea'
property :language_code, as: 'languageCode'
property :locality, as: 'locality'
property :organization, as: 'organization'
property :postal_code, as: 'postalCode'
collection :recipients, as: 'recipients'
property :region_code, as: 'regionCode'
property :revision, as: 'revision'
property :sorting_code, as: 'sortingCode'
property :sublocality, as: 'sublocality'
end
end
class RegisterDomainRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :contact_notices, as: 'contactNotices'
collection :domain_notices, as: 'domainNotices'
property :registration, as: 'registration', class: Google::Apis::DomainsV1beta1::Registration, decorator: Google::Apis::DomainsV1beta1::Registration::Representation
property :validate_only, as: 'validateOnly'
property :yearly_price, as: 'yearlyPrice', class: Google::Apis::DomainsV1beta1::Money, decorator: Google::Apis::DomainsV1beta1::Money::Representation
end
end
class RegisterParameters
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :availability, as: 'availability'
property :domain_name, as: 'domainName'
collection :domain_notices, as: 'domainNotices'
collection :supported_privacy, as: 'supportedPrivacy'
property :yearly_price, as: 'yearlyPrice', class: Google::Apis::DomainsV1beta1::Money, decorator: Google::Apis::DomainsV1beta1::Money::Representation
end
end
class Registration
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :contact_settings, as: 'contactSettings', class: Google::Apis::DomainsV1beta1::ContactSettings, decorator: Google::Apis::DomainsV1beta1::ContactSettings::Representation
property :create_time, as: 'createTime'
property :dns_settings, as: 'dnsSettings', class: Google::Apis::DomainsV1beta1::DnsSettings, decorator: Google::Apis::DomainsV1beta1::DnsSettings::Representation
property :domain_name, as: 'domainName'
property :expire_time, as: 'expireTime'
collection :issues, as: 'issues'
hash :labels, as: 'labels'
property :management_settings, as: 'managementSettings', class: Google::Apis::DomainsV1beta1::ManagementSettings, decorator: Google::Apis::DomainsV1beta1::ManagementSettings::Representation
property :name, as: 'name'
property :pending_contact_settings, as: 'pendingContactSettings', class: Google::Apis::DomainsV1beta1::ContactSettings, decorator: Google::Apis::DomainsV1beta1::ContactSettings::Representation
property :state, as: 'state'
collection :supported_privacy, as: 'supportedPrivacy'
end
end
class ResetAuthorizationCodeRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class RetrieveRegisterParametersResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :register_parameters, as: 'registerParameters', class: Google::Apis::DomainsV1beta1::RegisterParameters, decorator: Google::Apis::DomainsV1beta1::RegisterParameters::Representation
end
end
class SearchDomainsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :register_parameters, as: 'registerParameters', class: Google::Apis::DomainsV1beta1::RegisterParameters, decorator: Google::Apis::DomainsV1beta1::RegisterParameters::Representation
end
end
class SetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :policy, as: 'policy', class: Google::Apis::DomainsV1beta1::Policy, decorator: Google::Apis::DomainsV1beta1::Policy::Representation
property :update_mask, as: 'updateMask'
end
end
class Status
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
collection :details, as: 'details'
property :message, as: 'message'
end
end
class TestIamPermissionsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
end
end
class TestIamPermissionsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
end
end
end
end
end
@@ -0,0 +1,805 @@
# 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 '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 DomainsV1beta1
# Cloud Domains API
#
# Enables management and configuration of domain names.
#
# @example
# require 'google/apis/domains_v1beta1'
#
# Domains = Google::Apis::DomainsV1beta1 # Alias the module
# service = Domains::CloudDomainsService.new
#
# @see https://cloud.google.com/domains/
class CloudDomainsService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://domains.googleapis.com/', '')
@batch_path = 'batch'
end
# Gets information about a location.
# @param [String] name
# Resource name for the location.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::Location] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::Location]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::DomainsV1beta1::Location::Representation
command.response_class = Google::Apis::DomainsV1beta1::Location
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists information about the supported locations for this service.
# @param [String] name
# The resource that owns the locations collection, if applicable.
# @param [String] filter
# The standard list filter.
# @param [Fixnum] page_size
# The standard list page size.
# @param [String] page_token
# The standard list page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::ListLocationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::ListLocationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}/locations', options)
command.response_representation = Google::Apis::DomainsV1beta1::ListLocationsResponse::Representation
command.response_class = Google::Apis::DomainsV1beta1::ListLocationsResponse
command.params['name'] = name unless name.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the latest state of a long-running operation. Clients can use this method
# to poll the operation result at intervals as recommended by the API service.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::DomainsV1beta1::Operation::Representation
command.response_class = Google::Apis::DomainsV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists operations that match the specified filter in the request. If the server
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
# binding allows API services to override the binding to use different resource
# name schemes, such as `users/*/operations`. To override the binding, API
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
# service configuration. For backwards compatibility, the default name includes
# the operations collection id, however overriding users must ensure the name
# binding is the parent resource, without the operations collection id.
# @param [String] name
# The name of the operation's parent resource.
# @param [String] filter
# The standard list filter.
# @param [Fixnum] page_size
# The standard list page size.
# @param [String] page_token
# The standard list page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::ListOperationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::ListOperationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
command.response_representation = Google::Apis::DomainsV1beta1::ListOperationsResponse::Representation
command.response_class = Google::Apis::DomainsV1beta1::ListOperationsResponse
command.params['name'] = name unless name.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a `Registration`'s contact settings. Some changes require confirmation
# by the domain's registrant contact .
# @param [String] registration
# Required. The name of the `Registration` whose contact settings are being
# updated, in the format `projects/*/locations/*/registrations/*`.
# @param [Google::Apis::DomainsV1beta1::ConfigureContactSettingsRequest] configure_contact_settings_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def configure_registration_contact_settings(registration, configure_contact_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+registration}:configureContactSettings', options)
command.request_representation = Google::Apis::DomainsV1beta1::ConfigureContactSettingsRequest::Representation
command.request_object = configure_contact_settings_request_object
command.response_representation = Google::Apis::DomainsV1beta1::Operation::Representation
command.response_class = Google::Apis::DomainsV1beta1::Operation
command.params['registration'] = registration unless registration.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a `Registration`'s DNS settings.
# @param [String] registration
# Required. The name of the `Registration` whose DNS settings are being updated,
# in the format `projects/*/locations/*/registrations/*`.
# @param [Google::Apis::DomainsV1beta1::ConfigureDnsSettingsRequest] configure_dns_settings_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def configure_registration_dns_settings(registration, configure_dns_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+registration}:configureDnsSettings', options)
command.request_representation = Google::Apis::DomainsV1beta1::ConfigureDnsSettingsRequest::Representation
command.request_object = configure_dns_settings_request_object
command.response_representation = Google::Apis::DomainsV1beta1::Operation::Representation
command.response_class = Google::Apis::DomainsV1beta1::Operation
command.params['registration'] = registration unless registration.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a `Registration`'s management settings.
# @param [String] registration
# Required. The name of the `Registration` whose management settings are being
# updated, in the format `projects/*/locations/*/registrations/*`.
# @param [Google::Apis::DomainsV1beta1::ConfigureManagementSettingsRequest] configure_management_settings_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def configure_registration_management_settings(registration, configure_management_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+registration}:configureManagementSettings', options)
command.request_representation = Google::Apis::DomainsV1beta1::ConfigureManagementSettingsRequest::Representation
command.request_object = configure_management_settings_request_object
command.response_representation = Google::Apis::DomainsV1beta1::Operation::Representation
command.response_class = Google::Apis::DomainsV1beta1::Operation
command.params['registration'] = registration unless registration.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a `Registration` resource. This method only works on resources in one
# of the following states: * `state` is `EXPORTED` with `expire_time` in the
# past * `state` is `REGISTRATION_FAILED`
# @param [String] name
# Required. The name of the `Registration` to delete, in the format `projects/*/
# locations/*/registrations/*`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_location_registration(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::DomainsV1beta1::Operation::Representation
command.response_class = Google::Apis::DomainsV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Exports a `Registration` that you no longer want to use with Cloud Domains.
# You can continue to use the domain in [Google Domains](https://domains.google/)
# until it expires. If the export is successful: * The resource's `state`
# becomes `EXPORTED`, meaning that it is no longer managed by Cloud Domains *
# Because individual users can own domains in Google Domains, the calling user
# becomes the domain's sole owner. Permissions for the domain are subsequently
# managed in Google Domains. * Without further action, the domain does not renew
# automatically. The new owner can set up billing in Google Domains to renew the
# domain if needed.
# @param [String] name
# Required. The name of the `Registration` to export, in the format `projects/*/
# locations/*/registrations/*`.
# @param [Google::Apis::DomainsV1beta1::ExportRegistrationRequest] export_registration_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def export_registration(name, export_registration_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:export', options)
command.request_representation = Google::Apis::DomainsV1beta1::ExportRegistrationRequest::Representation
command.request_object = export_registration_request_object
command.response_representation = Google::Apis::DomainsV1beta1::Operation::Representation
command.response_class = Google::Apis::DomainsV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the details of a `Registration` resource.
# @param [String] name
# Required. The name of the `Registration` to get, in the format `projects/*/
# locations/*/registrations/*`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::Registration] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::Registration]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_registration(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::DomainsV1beta1::Registration::Representation
command.response_class = Google::Apis::DomainsV1beta1::Registration
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The policy format version to be returned. Valid values are 0, 1, and
# 3. Requests specifying an invalid value will be rejected. Requests for
# policies with any conditional bindings must specify version 3. Policies
# without any conditional bindings may specify any valid value or leave the
# field unset. To learn which resources support conditions in their IAM policies,
# see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
# resource-policies).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_registration_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::DomainsV1beta1::Policy::Representation
command.response_class = Google::Apis::DomainsV1beta1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the `Registration` resources in a project.
# @param [String] parent
# Required. The project and location from which to list `Registration`s,
# specified in the format `projects/*/locations/*`.
# @param [String] filter
# Filter expression to restrict the `Registration`s returned. The expression
# must specify the field name, a comparison operator, and the value that you
# want to use for filtering. The value must be a string, a number, a boolean, or
# an enum value. The comparison operator should be one of =, !=, >, <, >=, <=,
# or : for prefix or wildcard matches. For example, to filter to a specific
# domain name, use an expression like `domainName="example.com"`. You can also
# check for the existence of a field; for example, to find domains using custom
# DNS settings, use an expression like `dnsSettings.customDns:*`. You can also
# create compound filters by combining expressions with the `AND` and `OR`
# operators. For example, to find domains that are suspended or have specific
# issues flagged, use an expression like `(state=SUSPENDED) OR (issue:*)`.
# @param [Fixnum] page_size
# Maximum number of results to return.
# @param [String] page_token
# When set to the `next_page_token` from a prior response, provides the next
# page of results.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::ListRegistrationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::ListRegistrationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_registrations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/registrations', options)
command.response_representation = Google::Apis::DomainsV1beta1::ListRegistrationsResponse::Representation
command.response_class = Google::Apis::DomainsV1beta1::ListRegistrationsResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates select fields of a `Registration` resource, notably `labels`. To
# update other fields, use the appropriate custom update method: * To update
# management settings, see `ConfigureManagementSettings` * To update DNS
# configuration, see `ConfigureDnsSettings` * To update contact information, see
# `ConfigureContactSettings`
# @param [String] name
# Output only. Name of the `Registration` resource, in the format `projects/*/
# locations/*/registrations/`.
# @param [Google::Apis::DomainsV1beta1::Registration] registration_object
# @param [String] update_mask
# Required. The field mask describing which fields to update as a comma-
# separated list. For example, if only the labels are being updated, the `
# update_mask` would be `"labels"`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_location_registration(name, registration_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
command.request_representation = Google::Apis::DomainsV1beta1::Registration::Representation
command.request_object = registration_object
command.response_representation = Google::Apis::DomainsV1beta1::Operation::Representation
command.response_class = Google::Apis::DomainsV1beta1::Operation
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Registers a new domain name and creates a corresponding `Registration`
# resource. Call `RetrieveRegisterParameters` first to check availability of the
# domain name and determine parameters like price that are needed to build a
# call to this method. A successful call creates a `Registration` resource in
# state `REGISTRATION_PENDING`, which resolves to `ACTIVE` within 1-2 minutes,
# indicating that the domain was successfully registered. If the resource ends
# up in state `REGISTRATION_FAILED`, it indicates that the domain was not
# registered successfully, and you can safely delete the resource and retry
# registration.
# @param [String] parent
# Required. The parent resource of the `Registration`. Must be in the format `
# projects/*/locations/*`.
# @param [Google::Apis::DomainsV1beta1::RegisterDomainRequest] register_domain_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def register_registration_domain(parent, register_domain_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+parent}/registrations:register', options)
command.request_representation = Google::Apis::DomainsV1beta1::RegisterDomainRequest::Representation
command.request_object = register_domain_request_object
command.response_representation = Google::Apis::DomainsV1beta1::Operation::Representation
command.response_class = Google::Apis::DomainsV1beta1::Operation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Resets the authorization code of the `Registration` to a new random string.
# You can call this method only after 60 days have elapsed since the initial
# domain registration.
# @param [String] registration
# Required. The name of the `Registration` whose authorization code is being
# reset, in the format `projects/*/locations/*/registrations/*`.
# @param [Google::Apis::DomainsV1beta1::ResetAuthorizationCodeRequest] reset_authorization_code_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::AuthorizationCode] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::AuthorizationCode]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def reset_registration_authorization_code(registration, reset_authorization_code_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+registration}:resetAuthorizationCode', options)
command.request_representation = Google::Apis::DomainsV1beta1::ResetAuthorizationCodeRequest::Representation
command.request_object = reset_authorization_code_request_object
command.response_representation = Google::Apis::DomainsV1beta1::AuthorizationCode::Representation
command.response_class = Google::Apis::DomainsV1beta1::AuthorizationCode
command.params['registration'] = registration unless registration.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the authorization code of the `Registration` for the purpose of
# transferring the domain to another registrar. You can call this method only
# after 60 days have elapsed since the initial domain registration.
# @param [String] registration
# Required. The name of the `Registration` whose authorization code is being
# retrieved, in the format `projects/*/locations/*/registrations/*`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::AuthorizationCode] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::AuthorizationCode]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def retrieve_project_location_registration_authorization_code(registration, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+registration}:retrieveAuthorizationCode', options)
command.response_representation = Google::Apis::DomainsV1beta1::AuthorizationCode::Representation
command.response_class = Google::Apis::DomainsV1beta1::AuthorizationCode
command.params['registration'] = registration unless registration.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets parameters needed to register a new domain name, including price and up-
# to-date availability. Use the returned values to call `RegisterDomain`.
# @param [String] location
# Required. The location. Must be in the format `projects/*/locations/*`.
# @param [String] domain_name
# Required. The domain name. Unicode domain names must be expressed in Punycode
# format.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::RetrieveRegisterParametersResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::RetrieveRegisterParametersResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def retrieve_project_location_registration_register_parameters(location, domain_name: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+location}/registrations:retrieveRegisterParameters', options)
command.response_representation = Google::Apis::DomainsV1beta1::RetrieveRegisterParametersResponse::Representation
command.response_class = Google::Apis::DomainsV1beta1::RetrieveRegisterParametersResponse
command.params['location'] = location unless location.nil?
command.query['domainName'] = domain_name unless domain_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Searches for available domain names similar to the provided query.
# Availability results from this method are approximate; call `
# RetrieveRegisterParameters` on a domain before registering to confirm
# availability.
# @param [String] location
# Required. The location. Must be in the format `projects/*/locations/*`.
# @param [String] query
# Required. String used to search for available domain names.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::SearchDomainsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::SearchDomainsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def search_project_location_registration_domains(location, query: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+location}/registrations:searchDomains', options)
command.response_representation = Google::Apis::DomainsV1beta1::SearchDomainsResponse::Representation
command.response_class = Google::Apis::DomainsV1beta1::SearchDomainsResponse
command.params['location'] = location unless location.nil?
command.query['query'] = query unless query.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
# PERMISSION_DENIED` errors.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DomainsV1beta1::SetIamPolicyRequest] set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_registration_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::DomainsV1beta1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::DomainsV1beta1::Policy::Representation
command.response_class = Google::Apis::DomainsV1beta1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified resource. If the
# resource does not exist, this will return an empty set of permissions, not a `
# NOT_FOUND` error. Note: This operation is designed to be used for building
# permission-aware UIs and command-line tools, not for authorization checking.
# This operation may "fail open" without warning.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DomainsV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DomainsV1beta1::TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DomainsV1beta1::TestIamPermissionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_registration_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::DomainsV1beta1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::DomainsV1beta1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::DomainsV1beta1::TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
+1 -1
View File
@@ -29,7 +29,7 @@ module Google
# @see https://cloud.google.com/monitoring/api/
module MonitoringV3
VERSION = 'V3'
REVISION = '20201005'
REVISION = '20201011'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -2176,10 +2176,10 @@ module Google
# which time series should be compared with the threshold.The filter is similar
# to the one that is specified in the ListTimeSeries request (https://cloud.
# google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that call
# is useful to verify the time series that will be retrieved / processed) and
# must specify the metric type and optionally may contain restrictions on
# resource type, resource labels, and metric labels. This field may not exceed
# 2048 Unicode characters in length.
# is useful to verify the time series that will be retrieved / processed). The
# filter must specify the metric type and the resource type. Optionally, it can
# specify resource labels and metric labels. This field must not exceed 2048
# Unicode characters in length.
# Corresponds to the JSON property `filter`
# @return [String]
attr_accessor :filter
@@ -2473,10 +2473,10 @@ module Google
# which time series should be compared with the threshold.The filter is similar
# to the one that is specified in the ListTimeSeries request (https://cloud.
# google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that call
# is useful to verify the time series that will be retrieved / processed) and
# must specify the metric type and optionally may contain restrictions on
# resource type, resource labels, and metric labels. This field may not exceed
# 2048 Unicode characters in length.
# is useful to verify the time series that will be retrieved / processed). The
# filter must specify the metric type and the resource type. Optionally, it can
# specify resource labels and metric labels. This field must not exceed 2048
# Unicode characters in length.
# Corresponds to the JSON property `filter`
# @return [String]
attr_accessor :filter
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/maps/contact-sales/
module PlayablelocationsV3
VERSION = 'V3'
REVISION = '20200826'
REVISION = '20201013'
end
end
end
@@ -303,8 +303,8 @@ module Google
class GoogleMapsPlayablelocationsV3SamplePlayableLocation
include Google::Apis::Core::Hashable
# An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless
# An object that represents a latitude/longitude pair. This is expressed as a
# pair of doubles to represent degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the WGS84 standard. Values must be
# within normalized ranges.
# Corresponds to the JSON property `centerPoint`
@@ -326,8 +326,8 @@ module Google
# @return [String]
attr_accessor :plus_code
# An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless
# An object that represents a latitude/longitude pair. This is expressed as a
# pair of doubles to represent degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the WGS84 standard. Values must be
# within normalized ranges.
# Corresponds to the JSON property `snappedPoint`
@@ -554,8 +554,8 @@ module Google
end
end
# An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless
# An object that represents a latitude/longitude pair. This is expressed as a
# pair of doubles to represent degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the WGS84 standard. Values must be
# within normalized ranges.
class GoogleTypeLatLng
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/spectrum-access-system/
module ProdTtSasportalV1alpha1
VERSION = 'V1alpha1'
REVISION = '20200908'
REVISION = '20201013'
# View your email address
AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email'
@@ -825,6 +825,115 @@ module Google
execute_or_queue_command(command, &block)
end
# Creates a device under a node or customer.
# @param [String] parent
# Required. The name of the parent resource.
# @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] sas_portal_device_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_customer_node_device(parent, sas_portal_device_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1alpha1/{+parent}/devices', options)
command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation
command.request_object = sas_portal_device_object
command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation
command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a signed device under a node or customer.
# @param [String] parent
# Required. The name of the parent resource.
# @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_customer_node_device_signed(parent, sas_portal_create_signed_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1alpha1/{+parent}/devices:createSigned', options)
command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalCreateSignedDeviceRequest::Representation
command.request_object = sas_portal_create_signed_device_request_object
command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation
command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists devices under a node or customer.
# @param [String] parent
# Required. The name of the parent resource.
# @param [String] filter
# The filter expression. The filter should have one of the following formats: "
# sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the
# device. The filter is case insensitive.
# @param [Fixnum] page_size
# The maximum number of devices to return in the response. If empty or zero, all
# devices will be listed. Must be in the range [0, 1000].
# @param [String] page_token
# A pagination token returned from a previous call to ListDevices that indicates
# where this listing should continue from.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_customer_node_devices(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1alpha1/{+parent}/devices', options)
command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse::Representation
command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new node.
# @param [String] parent
# Required. The parent resource name where the node is to be created.
+1 -1
View File
@@ -26,7 +26,7 @@ module Google
# @see https://devsite.googleplex.com/youtube/partner/docs/v1/
module YoutubePartnerV1
VERSION = 'V1'
REVISION = '20201008'
REVISION = '20201014'
# View and manage your assets and associated content on YouTube
AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner'
+1 -1
View File
@@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/youtube/
module YoutubeV3
VERSION = 'V3'
REVISION = '20201007'
REVISION = '20201013'
# Manage your YouTube account
AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube'
+2 -2
View File
@@ -44,8 +44,8 @@ module Google
attr_accessor :quota_user
def initialize
super('https://www.googleapis.com/', '')
@batch_path = 'batch/youtube/v3'
super('https://youtube.googleapis.com/', '')
@batch_path = 'batch'
end
# Inserts a new resource into this collection.