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

789 lines
47 KiB
Ruby
Raw Normal View History

2016-01-29 22:32:46 +00:00
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require '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 LoggingV2beta1
2016-10-04 00:27:26 +00:00
# Stackdriver Logging API
2016-01-29 22:32:46 +00:00
#
2016-10-04 00:27:26 +00:00
# Writes log entries and manages your Stackdriver Logging configuration.
2016-01-29 22:32:46 +00:00
#
# @example
# require 'google/apis/logging_v2beta1'
#
# Logging = Google::Apis::LoggingV2beta1 # Alias the module
# service = Logging::LoggingService.new
#
# @see https://cloud.google.com/logging/docs/
class LoggingService < Google::Apis::Core::BaseService
2017-01-20 23:27:22 +00:00
# @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
# @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
2016-01-29 22:32:46 +00:00
def initialize
super('https://logging.googleapis.com/', '')
end
# Lists the descriptors for monitored resource types used by Stackdriver Logging.
2017-01-13 23:04:35 +00:00
# @param [String] page_token
# Optional. If present, then retrieve the next batch of results from the
# preceding call to this method. pageToken must be the value of nextPageToken
# from the previous response. The values of other method parameters should be
# identical to those in the previous call.
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
2017-01-13 23:04:35 +00:00
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2017-01-13 23:04:35 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse] parsed result object
2017-01-13 23:04:35 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse]
2017-01-13 23:04:35 +00:00
#
# @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_monitored_resource_descriptors(page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/monitoredResourceDescriptors', options)
command.response_representation = Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse
2017-01-13 23:04:35 +00:00
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
2017-01-20 23:27:22 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2017-01-13 23:04:35 +00:00
execute_or_queue_command(command, &block)
end
# Deletes all the log entries in a log. The log reappears if it receives new
# entries.
# @param [String] log_name
# Required. The resource name of the log to delete:
# "projects/[PROJECT_ID]/logs/[LOG_ID]"
# "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
# [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog"
# , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%
# 2Factivity". For more information about log names, see LogEntry.
2017-01-13 23:04:35 +00:00
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2017-01-13 23:04:35 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object
2017-01-13 23:04:35 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::Empty]
2017-01-13 23:04:35 +00:00
#
# @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_organization_log(log_name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2beta1/{+logName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation
command.response_class = Google::Apis::LoggingV2beta1::Empty
command.params['logName'] = log_name unless log_name.nil?
2017-01-20 23:27:22 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2017-01-13 23:04:35 +00:00
execute_or_queue_command(command, &block)
end
2017-01-20 23:27:22 +00:00
# Lists the logs in projects or organizations. Only logs that have entries are
# listed.
# @param [String] parent
# Required. The resource name that owns the logs:
# "projects/[PROJECT_ID]"
# "organizations/[ORGANIZATION_ID]"
# @param [String] page_token
# Optional. If present, then retrieve the next batch of results from the
# preceding call to this method. pageToken must be the value of nextPageToken
# from the previous response. The values of other method parameters should be
# identical to those in the previous call.
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
2017-01-13 23:04:35 +00:00
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2017-01-13 23:04:35 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-01-20 23:27:22 +00:00
# @yieldparam result [Google::Apis::LoggingV2beta1::ListLogsResponse] parsed result object
2017-01-13 23:04:35 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-01-20 23:27:22 +00:00
# @return [Google::Apis::LoggingV2beta1::ListLogsResponse]
2017-01-13 23:04:35 +00:00
#
# @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_organization_logs(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
2017-01-20 23:27:22 +00:00
command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options)
command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
2016-10-04 00:27:26 +00:00
command.query['fields'] = fields unless fields.nil?
2016-01-29 22:32:46 +00:00
execute_or_queue_command(command, &block)
end
2017-01-20 23:27:22 +00:00
# Lists log entries. Use this method to retrieve log entries from Stackdriver
# Logging. For ways to export log entries, see Exporting Logs.
# @param [Google::Apis::LoggingV2beta1::ListLogEntriesRequest] list_log_entries_request_object
2016-01-29 22:32:46 +00:00
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2016-01-29 22:32:46 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-01-20 23:27:22 +00:00
# @yieldparam result [Google::Apis::LoggingV2beta1::ListLogEntriesResponse] parsed result object
2016-01-29 22:32:46 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-01-20 23:27:22 +00:00
# @return [Google::Apis::LoggingV2beta1::ListLogEntriesResponse]
2016-01-29 22:32:46 +00:00
#
# @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_entry_log_entries(list_log_entries_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
2017-01-20 23:27:22 +00:00
command = make_simple_command(:post, 'v2beta1/entries:list', options)
command.request_representation = Google::Apis::LoggingV2beta1::ListLogEntriesRequest::Representation
command.request_object = list_log_entries_request_object
command.response_representation = Google::Apis::LoggingV2beta1::ListLogEntriesResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::ListLogEntriesResponse
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2016-01-29 22:32:46 +00:00
execute_or_queue_command(command, &block)
end
2017-01-20 23:27:22 +00:00
# Writes log entries to Stackdriver Logging. All log entries are written by this
# method.
# @param [Google::Apis::LoggingV2beta1::WriteLogEntriesRequest] write_log_entries_request_object
2017-01-13 23:04:35 +00:00
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2017-01-13 23:04:35 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-01-20 23:27:22 +00:00
# @yieldparam result [Google::Apis::LoggingV2beta1::WriteLogEntriesResponse] parsed result object
2017-01-13 23:04:35 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-01-20 23:27:22 +00:00
# @return [Google::Apis::LoggingV2beta1::WriteLogEntriesResponse]
2017-01-13 23:04:35 +00:00
#
# @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 write_entry_log_entries(write_log_entries_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
2017-01-20 23:27:22 +00:00
command = make_simple_command(:post, 'v2beta1/entries:write', options)
command.request_representation = Google::Apis::LoggingV2beta1::WriteLogEntriesRequest::Representation
command.request_object = write_log_entries_request_object
command.response_representation = Google::Apis::LoggingV2beta1::WriteLogEntriesResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::WriteLogEntriesResponse
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-01-13 23:04:35 +00:00
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Deletes all the log entries in a log. The log reappears if it receives new
# entries.
# @param [String] log_name
# Required. The resource name of the log to delete:
# "projects/[PROJECT_ID]/logs/[LOG_ID]"
# "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
# [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog"
# , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%
# 2Factivity". For more information about log names, see LogEntry.
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::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_log(log_name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2beta1/{+logName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation
command.response_class = Google::Apis::LoggingV2beta1::Empty
command.params['logName'] = log_name unless log_name.nil?
2017-01-20 23:27:22 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2017-01-13 23:04:35 +00:00
execute_or_queue_command(command, &block)
end
2017-01-20 23:27:22 +00:00
# Lists the logs in projects or organizations. Only logs that have entries are
# listed.
2016-10-04 00:27:26 +00:00
# @param [String] parent
2017-01-20 23:27:22 +00:00
# Required. The resource name that owns the logs:
2017-01-13 23:04:35 +00:00
# "projects/[PROJECT_ID]"
2017-01-20 23:27:22 +00:00
# "organizations/[ORGANIZATION_ID]"
2016-10-04 00:27:26 +00:00
# @param [String] page_token
# Optional. If present, then retrieve the next batch of results from the
2017-01-13 23:04:35 +00:00
# preceding call to this method. pageToken must be the value of nextPageToken
# from the previous response. The values of other method parameters should be
# identical to those in the previous call.
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
2016-01-29 22:32:46 +00:00
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2016-01-29 22:32:46 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-01-20 23:27:22 +00:00
# @yieldparam result [Google::Apis::LoggingV2beta1::ListLogsResponse] parsed result object
2016-01-29 22:32:46 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-01-20 23:27:22 +00:00
# @return [Google::Apis::LoggingV2beta1::ListLogsResponse]
2016-01-29 22:32:46 +00:00
#
# @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_logs(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
2017-01-20 23:27:22 +00:00
command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options)
command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse
2016-10-04 00:27:26 +00:00
command.params['parent'] = parent unless parent.nil?
command.query['pageToken'] = page_token unless page_token.nil?
2017-01-13 23:04:35 +00:00
command.query['pageSize'] = page_size unless page_size.nil?
2016-01-29 22:32:46 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2016-10-04 00:27:26 +00:00
command.query['fields'] = fields unless fields.nil?
2016-01-29 22:32:46 +00:00
execute_or_queue_command(command, &block)
end
2017-01-13 23:04:35 +00:00
# Deletes a sink. If the sink has a unique writer_identity, then that service
# account is also deleted.
2016-10-04 00:27:26 +00:00
# @param [String] sink_name
2017-01-13 23:04:35 +00:00
# Required. The full resource name of the sink to delete, including the parent
# resource and the sink identifier:
# "projects/[PROJECT_ID]/sinks/[SINK_ID]"
# "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
# It is an error if the sink does not exist. Example: "projects/my-project-id/
# sinks/my-sink-id". It is an error if the sink does not exist.
2016-01-29 22:32:46 +00:00
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2016-01-29 22:32:46 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-01-13 23:04:35 +00:00
# @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object
2016-01-29 22:32:46 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-01-13 23:04:35 +00:00
# @return [Google::Apis::LoggingV2beta1::Empty]
2016-01-29 22:32:46 +00:00
#
# @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_sink(sink_name, quota_user: nil, fields: nil, options: nil, &block)
2017-01-13 23:04:35 +00:00
command = make_simple_command(:delete, 'v2beta1/{+sinkName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation
command.response_class = Google::Apis::LoggingV2beta1::Empty
2016-10-04 00:27:26 +00:00
command.params['sinkName'] = sink_name unless sink_name.nil?
2017-01-20 23:27:22 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2016-01-29 22:32:46 +00:00
execute_or_queue_command(command, &block)
end
2016-10-04 00:27:26 +00:00
# Lists sinks.
# @param [String] parent
2017-01-13 23:04:35 +00:00
# Required. The parent resource whose sinks are to be listed. Examples: "
# projects/my-logging-project", "organizations/123456789".
2016-10-04 00:27:26 +00:00
# @param [String] page_token
# Optional. If present, then retrieve the next batch of results from the
2017-01-13 23:04:35 +00:00
# preceding call to this method. pageToken must be the value of nextPageToken
# from the previous response. The values of other method parameters should be
# identical to those in the previous call.
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
2016-01-29 22:32:46 +00:00
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2016-01-29 22:32:46 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2016-10-04 00:27:26 +00:00
# @yieldparam result [Google::Apis::LoggingV2beta1::ListSinksResponse] parsed result object
2016-01-29 22:32:46 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2016-10-04 00:27:26 +00:00
# @return [Google::Apis::LoggingV2beta1::ListSinksResponse]
2016-01-29 22:32:46 +00:00
#
# @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_sinks(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
2016-10-04 00:27:26 +00:00
command = make_simple_command(:get, 'v2beta1/{+parent}/sinks', options)
command.response_representation = Google::Apis::LoggingV2beta1::ListSinksResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::ListSinksResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageToken'] = page_token unless page_token.nil?
2017-01-13 23:04:35 +00:00
command.query['pageSize'] = page_size unless page_size.nil?
2017-01-20 23:27:22 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2016-01-29 22:32:46 +00:00
execute_or_queue_command(command, &block)
end
2017-01-13 23:04:35 +00:00
# Gets a sink.
2016-10-04 00:27:26 +00:00
# @param [String] sink_name
2017-01-13 23:04:35 +00:00
# Required. The parent resource name of the sink:
# "projects/[PROJECT_ID]/sinks/[SINK_ID]"
# "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
# Example: "projects/my-project-id/sinks/my-sink-id".
2016-10-04 00:27:26 +00:00
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2016-10-04 00:27:26 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-01-13 23:04:35 +00:00
# @yieldparam result [Google::Apis::LoggingV2beta1::LogSink] parsed result object
2016-10-04 00:27:26 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-01-13 23:04:35 +00:00
# @return [Google::Apis::LoggingV2beta1::LogSink]
2016-10-04 00:27:26 +00:00
#
# @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_sink(sink_name, quota_user: nil, fields: nil, options: nil, &block)
2017-01-13 23:04:35 +00:00
command = make_simple_command(:get, 'v2beta1/{+sinkName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::LogSink::Representation
command.response_class = Google::Apis::LoggingV2beta1::LogSink
2016-10-04 00:27:26 +00:00
command.params['sinkName'] = sink_name unless sink_name.nil?
2017-01-20 23:27:22 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2016-10-04 00:27:26 +00:00
execute_or_queue_command(command, &block)
end
2017-01-13 23:04:35 +00:00
# Updates a sink. If the named sink doesn't exist, then this method is identical
# to sinks.create. If the named sink does exist, then this method replaces the
# following fields in the existing sink with values from the new sink:
# destination, filter, output_version_format, start_time, and end_time. The
# updated filter might also have a new writer_identity; see the
# unique_writer_identity field.
# @param [String] sink_name
# Required. The full resource name of the sink to update, including the parent
# resource and the sink identifier:
# "projects/[PROJECT_ID]/sinks/[SINK_ID]"
# "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
# Example: "projects/my-project-id/sinks/my-sink-id".
# @param [Google::Apis::LoggingV2beta1::LogSink] log_sink_object
# @param [Boolean] unique_writer_identity
# Optional. See sinks.create for a description of this field. When updating a
# sink, the effect of this field on the value of writer_identity in the updated
# sink depends on both the old and new values of this field:
# If the old and new values of this field are both false or both true, then
# there is no change to the sink's writer_identity.
# If the old value was false and the new value is true, then writer_identity is
# changed to a unique service account.
# It is an error if the old value was true and the new value is false.
2016-01-29 22:32:46 +00:00
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2016-01-29 22:32:46 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-01-13 23:04:35 +00:00
# @yieldparam result [Google::Apis::LoggingV2beta1::LogSink] parsed result object
2016-01-29 22:32:46 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-01-13 23:04:35 +00:00
# @return [Google::Apis::LoggingV2beta1::LogSink]
2016-01-29 22:32:46 +00:00
#
# @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 update_project_sink(sink_name, log_sink_object = nil, unique_writer_identity: nil, quota_user: nil, fields: nil, options: nil, &block)
2017-01-13 23:04:35 +00:00
command = make_simple_command(:put, 'v2beta1/{+sinkName}', options)
command.request_representation = Google::Apis::LoggingV2beta1::LogSink::Representation
command.request_object = log_sink_object
command.response_representation = Google::Apis::LoggingV2beta1::LogSink::Representation
command.response_class = Google::Apis::LoggingV2beta1::LogSink
command.params['sinkName'] = sink_name unless sink_name.nil?
command.query['uniqueWriterIdentity'] = unique_writer_identity unless unique_writer_identity.nil?
2017-01-20 23:27:22 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2016-01-29 22:32:46 +00:00
execute_or_queue_command(command, &block)
end
2017-01-13 23:04:35 +00:00
# Creates a sink that exports specified log entries to a destination. The export
# of newly-ingested log entries begins immediately, unless the current time is
# outside the sink's start and end times or the sink's writer_identity is not
# permitted to write to the destination. A sink can export log entries only from
# the resource owning the sink.
# @param [String] parent
# Required. The resource in which to create the sink:
# "projects/[PROJECT_ID]"
# "organizations/[ORGANIZATION_ID]"
# Examples: "projects/my-logging-project", "organizations/123456789".
# @param [Google::Apis::LoggingV2beta1::LogSink] log_sink_object
# @param [Boolean] unique_writer_identity
# Optional. Determines the kind of IAM identity returned as writer_identity in
# the new sink. If this value is omitted or set to false, and if the sink's
# parent is a project, then the value returned as writer_identity is cloud-logs@
# google.com, the same identity used before the addition of writer identities to
# this API. The sink's destination must be in the same project as the sink
# itself.If this field is set to true, or if the sink is owned by a non-project
# resource such as an organization, then the value of writer_identity will be a
# unique service account used only for exports from the new sink. For more
# information, see writer_identity in LogSink.
2016-01-29 22:32:46 +00:00
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2016-01-29 22:32:46 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-01-13 23:04:35 +00:00
# @yieldparam result [Google::Apis::LoggingV2beta1::LogSink] parsed result object
2016-01-29 22:32:46 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-01-13 23:04:35 +00:00
# @return [Google::Apis::LoggingV2beta1::LogSink]
2016-01-29 22:32:46 +00:00
#
# @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_project_sink(parent, log_sink_object = nil, unique_writer_identity: nil, quota_user: nil, fields: nil, options: nil, &block)
2017-01-13 23:04:35 +00:00
command = make_simple_command(:post, 'v2beta1/{+parent}/sinks', options)
command.request_representation = Google::Apis::LoggingV2beta1::LogSink::Representation
command.request_object = log_sink_object
command.response_representation = Google::Apis::LoggingV2beta1::LogSink::Representation
command.response_class = Google::Apis::LoggingV2beta1::LogSink
command.params['parent'] = parent unless parent.nil?
command.query['uniqueWriterIdentity'] = unique_writer_identity unless unique_writer_identity.nil?
2017-01-20 23:27:22 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2016-01-29 22:32:46 +00:00
execute_or_queue_command(command, &block)
end
2017-01-20 23:27:22 +00:00
# Deletes a logs-based metric.
# @param [String] metric_name
# The resource name of the metric to delete:
# "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
2016-01-29 22:32:46 +00:00
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2016-01-29 22:32:46 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-01-13 23:04:35 +00:00
# @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object
2016-01-29 22:32:46 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-01-13 23:04:35 +00:00
# @return [Google::Apis::LoggingV2beta1::Empty]
2016-01-29 22:32:46 +00:00
#
# @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_metric(metric_name, quota_user: nil, fields: nil, options: nil, &block)
2017-01-20 23:27:22 +00:00
command = make_simple_command(:delete, 'v2beta1/{+metricName}', options)
2017-01-13 23:04:35 +00:00
command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation
command.response_class = Google::Apis::LoggingV2beta1::Empty
2017-01-20 23:27:22 +00:00
command.params['metricName'] = metric_name unless metric_name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2016-01-29 22:32:46 +00:00
execute_or_queue_command(command, &block)
end
2017-01-20 23:27:22 +00:00
# Lists logs-based metrics.
2017-01-13 23:04:35 +00:00
# @param [String] parent
2017-01-20 23:27:22 +00:00
# Required. The name of the project containing the metrics:
2017-01-13 23:04:35 +00:00
# "projects/[PROJECT_ID]"
2016-01-29 22:32:46 +00:00
# @param [String] page_token
2016-10-04 00:27:26 +00:00
# Optional. If present, then retrieve the next batch of results from the
2017-01-13 23:04:35 +00:00
# preceding call to this method. pageToken must be the value of nextPageToken
# from the previous response. The values of other method parameters should be
# identical to those in the previous call.
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
2016-01-29 22:32:46 +00:00
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2016-01-29 22:32:46 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-01-20 23:27:22 +00:00
# @yieldparam result [Google::Apis::LoggingV2beta1::ListLogMetricsResponse] parsed result object
2016-01-29 22:32:46 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-01-20 23:27:22 +00:00
# @return [Google::Apis::LoggingV2beta1::ListLogMetricsResponse]
2016-01-29 22:32:46 +00:00
#
# @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_metrics(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
2017-01-20 23:27:22 +00:00
command = make_simple_command(:get, 'v2beta1/{+parent}/metrics', options)
command.response_representation = Google::Apis::LoggingV2beta1::ListLogMetricsResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::ListLogMetricsResponse
2017-01-13 23:04:35 +00:00
command.params['parent'] = parent unless parent.nil?
2016-01-29 22:32:46 +00:00
command.query['pageToken'] = page_token unless page_token.nil?
2017-01-13 23:04:35 +00:00
command.query['pageSize'] = page_size unless page_size.nil?
2017-01-20 23:27:22 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2016-10-04 00:27:26 +00:00
execute_or_queue_command(command, &block)
end
2017-01-20 23:27:22 +00:00
# Gets a logs-based metric.
# @param [String] metric_name
# The resource name of the desired metric:
# "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
2016-10-04 00:27:26 +00:00
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2017-01-20 23:27:22 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LoggingV2beta1::LogMetric] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::LogMetric]
#
# @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_metric(metric_name, quota_user: nil, fields: nil, options: nil, &block)
2017-01-20 23:27:22 +00:00
command = make_simple_command(:get, 'v2beta1/{+metricName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation
command.response_class = Google::Apis::LoggingV2beta1::LogMetric
command.params['metricName'] = metric_name unless metric_name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2017-01-20 23:27:22 +00:00
execute_or_queue_command(command, &block)
end
# Creates or updates a logs-based metric.
# @param [String] metric_name
# The resource name of the metric to update:
# "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
# The updated metric must be provided in the request and it's name field must be
# the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a
# new metric is created.
# @param [Google::Apis::LoggingV2beta1::LogMetric] log_metric_object
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2016-10-04 00:27:26 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-01-20 23:27:22 +00:00
# @yieldparam result [Google::Apis::LoggingV2beta1::LogMetric] parsed result object
2016-10-04 00:27:26 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-01-20 23:27:22 +00:00
# @return [Google::Apis::LoggingV2beta1::LogMetric]
2016-10-04 00:27:26 +00:00
#
# @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 update_project_metric(metric_name, log_metric_object = nil, quota_user: nil, fields: nil, options: nil, &block)
2017-01-20 23:27:22 +00:00
command = make_simple_command(:put, 'v2beta1/{+metricName}', options)
command.request_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation
command.request_object = log_metric_object
command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation
command.response_class = Google::Apis::LoggingV2beta1::LogMetric
command.params['metricName'] = metric_name unless metric_name.nil?
2016-01-29 22:32:46 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2017-01-20 23:27:22 +00:00
execute_or_queue_command(command, &block)
end
# Creates a logs-based metric.
# @param [String] parent
# The resource name of the project in which to create the metric:
# "projects/[PROJECT_ID]"
# The new metric must be provided in the request.
# @param [Google::Apis::LoggingV2beta1::LogMetric] log_metric_object
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
2017-01-20 23:27:22 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LoggingV2beta1::LogMetric] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::LogMetric]
#
# @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_project_metric(parent, log_metric_object = nil, quota_user: nil, fields: nil, options: nil, &block)
2017-01-20 23:27:22 +00:00
command = make_simple_command(:post, 'v2beta1/{+parent}/metrics', options)
command.request_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation
command.request_object = log_metric_object
command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation
command.response_class = Google::Apis::LoggingV2beta1::LogMetric
command.params['parent'] = parent unless parent.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Deletes all the log entries in a log. The log reappears if it receives new
# entries.
# @param [String] log_name
# Required. The resource name of the log to delete:
# "projects/[PROJECT_ID]/logs/[LOG_ID]"
# "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
# [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog"
# , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%
# 2Factivity". For more information about log names, see LogEntry.
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::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_billing_account_log(log_name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2beta1/{+logName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation
command.response_class = Google::Apis::LoggingV2beta1::Empty
command.params['logName'] = log_name unless log_name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
2016-10-04 00:27:26 +00:00
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Lists the logs in projects or organizations. Only logs that have entries are
# listed.
# @param [String] parent
# Required. The resource name that owns the logs:
# "projects/[PROJECT_ID]"
# "organizations/[ORGANIZATION_ID]"
# @param [String] page_token
# Optional. If present, then retrieve the next batch of results from the
# preceding call to this method. pageToken must be the value of nextPageToken
# from the previous response. The values of other method parameters should be
# identical to those in the previous call.
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
# @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 [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LoggingV2beta1::ListLogsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::ListLogsResponse]
#
# @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_billing_account_logs(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options)
command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
2017-01-20 23:27:22 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2016-01-29 22:32:46 +00:00
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
2017-01-20 23:27:22 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['key'] = key unless key.nil?
2016-01-29 22:32:46 +00:00
end
end
end
end
end