google-api-ruby-client/google-api-client/generated/google/apis/serviceusage_v1/service.rb

449 lines
27 KiB
Ruby
Raw Normal View History

# 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 ServiceusageV1
# Service Usage API
#
# Enables services that service consumers want to use on Google Cloud Platform,
# lists the available or enabled services, or disables services that service
# consumers no longer use.
#
# @example
# require 'google/apis/serviceusage_v1'
#
# Serviceusage = Google::Apis::ServiceusageV1 # Alias the module
# service = Serviceusage::ServiceUsageService.new
#
# @see https://cloud.google.com/service-usage/
class ServiceUsageService < 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://serviceusage.googleapis.com/', '')
@batch_path = 'batch'
end
# Starts asynchronous cancellation on a long-running operation. The server makes
# a best effort to cancel the operation, but success is not guaranteed. If the
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
# Clients can use Operations.GetOperation or other methods to check whether the
# cancellation succeeded or whether the operation completed despite cancellation.
# On successful cancellation, the operation is not deleted; instead, it becomes
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
# corresponding to `Code.CANCELLED`.
# @param [String] name
# The name of the operation resource to be cancelled.
# @param [Google::Apis::ServiceusageV1::CancelOperationRequest] cancel_operation_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::ServiceusageV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServiceusageV1::Empty]
#
# @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 cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
command.request_representation = Google::Apis::ServiceusageV1::CancelOperationRequest::Representation
command.request_object = cancel_operation_request_object
command.response_representation = Google::Apis::ServiceusageV1::Empty::Representation
command.response_class = Google::Apis::ServiceusageV1::Empty
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
# Deletes a long-running operation. This method indicates that the client is no
# longer interested in the operation result. It does not cancel the operation.
# If the server doesn't support this method, it returns `google.rpc.Code.
# UNIMPLEMENTED`.
# @param [String] name
# The name of the operation resource to be deleted.
# @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::ServiceusageV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServiceusageV1::Empty]
#
# @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_operation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ServiceusageV1::Empty::Representation
command.response_class = Google::Apis::ServiceusageV1::Empty
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 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::ServiceusageV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServiceusageV1::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_operation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ServiceusageV1::Operation::Representation
command.response_class = Google::Apis::ServiceusageV1::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] filter
# The standard list filter.
# @param [String] name
# The name of the operation's parent resource.
# @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::ServiceusageV1::ListOperationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServiceusageV1::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_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/operations', options)
command.response_representation = Google::Apis::ServiceusageV1::ListOperationsResponse::Representation
command.response_class = Google::Apis::ServiceusageV1::ListOperationsResponse
command.query['filter'] = filter unless filter.nil?
command.query['name'] = name unless name.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
# Enable multiple services on a project. The operation is atomic: if enabling
# any service fails, then the entire batch fails, and no state changes occur. To
# enable a single service, use the `EnableService` method instead.
# @param [String] parent
# Parent to enable services on. An example name would be: `projects/123` where `
# 123` is the project number. The `BatchEnableServices` method currently only
# supports projects.
# @param [Google::Apis::ServiceusageV1::BatchEnableServicesRequest] batch_enable_services_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::ServiceusageV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServiceusageV1::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 batch_enable_services(parent, batch_enable_services_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/services:batchEnable', options)
command.request_representation = Google::Apis::ServiceusageV1::BatchEnableServicesRequest::Representation
command.request_object = batch_enable_services_request_object
command.response_representation = Google::Apis::ServiceusageV1::Operation::Representation
command.response_class = Google::Apis::ServiceusageV1::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
Autogenerated update (2020-04-13) Delete: - cloudprivatecatalog_v1beta1 - cloudprivatecatalogproducer_v1beta1 - mirror_v1 - oauth2_v1 - proximitybeacon_v1beta1 Update: - accesscontextmanager_v1 - accesscontextmanager_v1beta - adexchangebuyer2_v2beta1 - admin_directory_v1 - adsense_v1_4 - adsensehost_v4_1 - alertcenter_v1beta1 - androiddeviceprovisioning_v1 - androidenterprise_v1 - androidmanagement_v1 - androidpublisher_v2 - androidpublisher_v3 - appengine_v1 - appengine_v1alpha - appengine_v1beta - bigquery_v2 - bigquerydatatransfer_v1 - bigqueryreservation_v1 - bigqueryreservation_v1beta1 - bigtableadmin_v1 - bigtableadmin_v2 - billingbudgets_v1beta1 - blogger_v2 - blogger_v3 - calendar_v3 - chat_v1 - cloudasset_v1 - cloudbuild_v1 - cloudbuild_v1alpha1 - cloudbuild_v1alpha2 - clouddebugger_v2 - cloudidentity_v1 - cloudidentity_v1beta1 - cloudresourcemanager_v1 - cloudsearch_v1 - cloudshell_v1 - cloudshell_v1alpha1 - cloudtasks_v2beta2 - cloudtrace_v1 - cloudtrace_v2 - cloudtrace_v2beta1 - composer_v1 - composer_v1beta1 - compute_alpha - compute_beta - compute_v1 - container_v1 - container_v1beta1 - content_v2 - content_v2_1 - customsearch_v1 - datacatalog_v1beta1 - dataflow_v1b3 - datafusion_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dfareporting_v3_3 - dfareporting_v3_4 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - doubleclickbidmanager_v1_1 - doubleclicksearch_v2 - drive_v2 - drive_v3 - file_v1 - file_v1beta1 - firebase_v1beta1 - firebasehosting_v1beta1 - firestore_v1 - firestore_v1beta1 - games_configuration_v1configuration - games_management_v1management - games_v1 - genomics_v2alpha1 - gmail_v1 - healthcare_v1beta1 - homegraph_v1 - iap_v1 - jobs_v2 - language_v1 - language_v1beta1 - language_v1beta2 - logging_v2 - managedidentities_v1 - managedidentities_v1alpha1 - managedidentities_v1beta1 - manufacturers_v1 - ml_v1 - monitoring_v1 - monitoring_v3 - oauth2_v2 - osconfig_v1beta - people_v1 - prod_tt_sasportal_v1alpha1 - pubsub_v1 - pubsub_v1beta2 - recommender_v1beta1 - redis_v1 - redis_v1beta1 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - run_v1 - sasportal_v1alpha1 - secretmanager_v1 - secretmanager_v1beta1 - securitycenter_v1 - securitycenter_v1beta1 - securitycenter_v1p1alpha1 - securitycenter_v1p1beta1 - serviceconsumermanagement_v1 - servicecontrol_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - spanner_v1 - speech_v1 - speech_v1p1beta1 - speech_v2beta1 - sql_v1beta4 - storage_v1 - storagetransfer_v1 - toolresults_v1beta3 - vault_v1 - videointelligence_v1 - videointelligence_v1beta2 - videointelligence_v1p1beta1 - videointelligence_v1p2beta1 - videointelligence_v1p3beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1 - youtube_partner_v1 - youtube_v3
2020-04-13 16:49:10 +00:00
# Returns the service configurations and enabled states for a given list of
# services.
# @param [String] parent
# Parent to retrieve services from. If this is set, the parent of all of the
# services specified in `names` must match this field. An example name would be:
# `projects/123` where `123` is the project number. The `BatchGetServices`
# method currently only supports projects.
Autogenerated update (2020-04-13) Delete: - cloudprivatecatalog_v1beta1 - cloudprivatecatalogproducer_v1beta1 - mirror_v1 - oauth2_v1 - proximitybeacon_v1beta1 Update: - accesscontextmanager_v1 - accesscontextmanager_v1beta - adexchangebuyer2_v2beta1 - admin_directory_v1 - adsense_v1_4 - adsensehost_v4_1 - alertcenter_v1beta1 - androiddeviceprovisioning_v1 - androidenterprise_v1 - androidmanagement_v1 - androidpublisher_v2 - androidpublisher_v3 - appengine_v1 - appengine_v1alpha - appengine_v1beta - bigquery_v2 - bigquerydatatransfer_v1 - bigqueryreservation_v1 - bigqueryreservation_v1beta1 - bigtableadmin_v1 - bigtableadmin_v2 - billingbudgets_v1beta1 - blogger_v2 - blogger_v3 - calendar_v3 - chat_v1 - cloudasset_v1 - cloudbuild_v1 - cloudbuild_v1alpha1 - cloudbuild_v1alpha2 - clouddebugger_v2 - cloudidentity_v1 - cloudidentity_v1beta1 - cloudresourcemanager_v1 - cloudsearch_v1 - cloudshell_v1 - cloudshell_v1alpha1 - cloudtasks_v2beta2 - cloudtrace_v1 - cloudtrace_v2 - cloudtrace_v2beta1 - composer_v1 - composer_v1beta1 - compute_alpha - compute_beta - compute_v1 - container_v1 - container_v1beta1 - content_v2 - content_v2_1 - customsearch_v1 - datacatalog_v1beta1 - dataflow_v1b3 - datafusion_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dfareporting_v3_3 - dfareporting_v3_4 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - doubleclickbidmanager_v1_1 - doubleclicksearch_v2 - drive_v2 - drive_v3 - file_v1 - file_v1beta1 - firebase_v1beta1 - firebasehosting_v1beta1 - firestore_v1 - firestore_v1beta1 - games_configuration_v1configuration - games_management_v1management - games_v1 - genomics_v2alpha1 - gmail_v1 - healthcare_v1beta1 - homegraph_v1 - iap_v1 - jobs_v2 - language_v1 - language_v1beta1 - language_v1beta2 - logging_v2 - managedidentities_v1 - managedidentities_v1alpha1 - managedidentities_v1beta1 - manufacturers_v1 - ml_v1 - monitoring_v1 - monitoring_v3 - oauth2_v2 - osconfig_v1beta - people_v1 - prod_tt_sasportal_v1alpha1 - pubsub_v1 - pubsub_v1beta2 - recommender_v1beta1 - redis_v1 - redis_v1beta1 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - run_v1 - sasportal_v1alpha1 - secretmanager_v1 - secretmanager_v1beta1 - securitycenter_v1 - securitycenter_v1beta1 - securitycenter_v1p1alpha1 - securitycenter_v1p1beta1 - serviceconsumermanagement_v1 - servicecontrol_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - spanner_v1 - speech_v1 - speech_v1p1beta1 - speech_v2beta1 - sql_v1beta4 - storage_v1 - storagetransfer_v1 - toolresults_v1beta3 - vault_v1 - videointelligence_v1 - videointelligence_v1beta2 - videointelligence_v1p1beta1 - videointelligence_v1p2beta1 - videointelligence_v1p3beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1 - youtube_partner_v1 - youtube_v3
2020-04-13 16:49:10 +00:00
# @param [Array<String>, String] names
# Names of the services to retrieve. An example name would be: `projects/123/
# services/serviceusage.googleapis.com` where `123` is the project number. A
# single request can get a maximum of 30 services at a time.
Autogenerated update (2020-04-13) Delete: - cloudprivatecatalog_v1beta1 - cloudprivatecatalogproducer_v1beta1 - mirror_v1 - oauth2_v1 - proximitybeacon_v1beta1 Update: - accesscontextmanager_v1 - accesscontextmanager_v1beta - adexchangebuyer2_v2beta1 - admin_directory_v1 - adsense_v1_4 - adsensehost_v4_1 - alertcenter_v1beta1 - androiddeviceprovisioning_v1 - androidenterprise_v1 - androidmanagement_v1 - androidpublisher_v2 - androidpublisher_v3 - appengine_v1 - appengine_v1alpha - appengine_v1beta - bigquery_v2 - bigquerydatatransfer_v1 - bigqueryreservation_v1 - bigqueryreservation_v1beta1 - bigtableadmin_v1 - bigtableadmin_v2 - billingbudgets_v1beta1 - blogger_v2 - blogger_v3 - calendar_v3 - chat_v1 - cloudasset_v1 - cloudbuild_v1 - cloudbuild_v1alpha1 - cloudbuild_v1alpha2 - clouddebugger_v2 - cloudidentity_v1 - cloudidentity_v1beta1 - cloudresourcemanager_v1 - cloudsearch_v1 - cloudshell_v1 - cloudshell_v1alpha1 - cloudtasks_v2beta2 - cloudtrace_v1 - cloudtrace_v2 - cloudtrace_v2beta1 - composer_v1 - composer_v1beta1 - compute_alpha - compute_beta - compute_v1 - container_v1 - container_v1beta1 - content_v2 - content_v2_1 - customsearch_v1 - datacatalog_v1beta1 - dataflow_v1b3 - datafusion_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dfareporting_v3_3 - dfareporting_v3_4 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - doubleclickbidmanager_v1_1 - doubleclicksearch_v2 - drive_v2 - drive_v3 - file_v1 - file_v1beta1 - firebase_v1beta1 - firebasehosting_v1beta1 - firestore_v1 - firestore_v1beta1 - games_configuration_v1configuration - games_management_v1management - games_v1 - genomics_v2alpha1 - gmail_v1 - healthcare_v1beta1 - homegraph_v1 - iap_v1 - jobs_v2 - language_v1 - language_v1beta1 - language_v1beta2 - logging_v2 - managedidentities_v1 - managedidentities_v1alpha1 - managedidentities_v1beta1 - manufacturers_v1 - ml_v1 - monitoring_v1 - monitoring_v3 - oauth2_v2 - osconfig_v1beta - people_v1 - prod_tt_sasportal_v1alpha1 - pubsub_v1 - pubsub_v1beta2 - recommender_v1beta1 - redis_v1 - redis_v1beta1 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - run_v1 - sasportal_v1alpha1 - secretmanager_v1 - secretmanager_v1beta1 - securitycenter_v1 - securitycenter_v1beta1 - securitycenter_v1p1alpha1 - securitycenter_v1p1beta1 - serviceconsumermanagement_v1 - servicecontrol_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - spanner_v1 - speech_v1 - speech_v1p1beta1 - speech_v2beta1 - sql_v1beta4 - storage_v1 - storagetransfer_v1 - toolresults_v1beta3 - vault_v1 - videointelligence_v1 - videointelligence_v1beta2 - videointelligence_v1p1beta1 - videointelligence_v1p2beta1 - videointelligence_v1p3beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1 - youtube_partner_v1 - youtube_v3
2020-04-13 16:49:10 +00:00
# @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::ServiceusageV1::BatchGetServicesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServiceusageV1::BatchGetServicesResponse]
#
# @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 batch_service_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/services:batchGet', options)
command.response_representation = Google::Apis::ServiceusageV1::BatchGetServicesResponse::Representation
command.response_class = Google::Apis::ServiceusageV1::BatchGetServicesResponse
command.params['parent'] = parent unless parent.nil?
command.query['names'] = names unless names.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Disable a service so that it can no longer be used with a project. This
# prevents unintended usage that may cause unexpected billing charges or
# security leaks. It is not valid to call the disable method on a service that
# is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status
# if the target service is not currently enabled.
# @param [String] name
# Name of the consumer and service to disable the service on. The enable and
# disable methods currently only support projects. An example name would be: `
# projects/123/services/serviceusage.googleapis.com` where `123` is the project
# number.
# @param [Google::Apis::ServiceusageV1::DisableServiceRequest] disable_service_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::ServiceusageV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServiceusageV1::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 disable_service(name, disable_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:disable', options)
command.request_representation = Google::Apis::ServiceusageV1::DisableServiceRequest::Representation
command.request_object = disable_service_request_object
command.response_representation = Google::Apis::ServiceusageV1::Operation::Representation
command.response_class = Google::Apis::ServiceusageV1::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
# Enable a service so that it can be used with a project.
# @param [String] name
# Name of the consumer and service to enable the service on. The `EnableService`
# and `DisableService` methods currently only support projects. Enabling a
# service requires that the service is public or is shared with the user
# enabling the service. An example name would be: `projects/123/services/
# serviceusage.googleapis.com` where `123` is the project number.
# @param [Google::Apis::ServiceusageV1::EnableServiceRequest] enable_service_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::ServiceusageV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServiceusageV1::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 enable_service(name, enable_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:enable', options)
command.request_representation = Google::Apis::ServiceusageV1::EnableServiceRequest::Representation
command.request_object = enable_service_request_object
command.response_representation = Google::Apis::ServiceusageV1::Operation::Representation
command.response_class = Google::Apis::ServiceusageV1::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
# Returns the service configuration and enabled state for a given service.
# @param [String] name
# Name of the consumer and service to get the `ConsumerState` for. An example
# name would be: `projects/123/services/serviceusage.googleapis.com` where `123`
# is the project number.
# @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::ServiceusageV1::GoogleApiServiceusageV1Service] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service]
#
# @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_service(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service::Representation
command.response_class = Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service
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
# List all services available to the specified project, and the current state of
# those services with respect to the project. The list includes all public
# services, all services for which the calling user has the `servicemanagement.
# services.bind` permission, and all services that have already been enabled on
# the project. The list can be filtered to only include services in a specific
# state, for example to only include services enabled on the project. WARNING:
# If you need to query enabled services frequently or across an organization,
# you should use [Cloud Asset Inventory API](https://cloud.google.com/asset-
# inventory/docs/apis), which provides higher throughput and richer filtering
# capability.
# @param [String] parent
# Parent to search for services on. An example name would be: `projects/123`
# where `123` is the project number.
# @param [String] filter
# Only list services that conform to the given filter. The allowed filter
# strings are `state:ENABLED` and `state:DISABLED`.
# @param [Fixnum] page_size
# Requested size of the next page of data. Requested page size cannot exceed 200.
# If not set, the default page size is 50.
# @param [String] page_token
# Token identifying which result to start with, which is returned by a previous
# list call.
# @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::ServiceusageV1::ListServicesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServiceusageV1::ListServicesResponse]
#
# @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_services(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/services', options)
command.response_representation = Google::Apis::ServiceusageV1::ListServicesResponse::Representation
command.response_class = Google::Apis::ServiceusageV1::ListServicesResponse
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
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