Class: Google::Cloud::Logging::V2::ConfigServiceV2Client

Inherits:

Object

Object
Google::Cloud::Logging::V2::ConfigServiceV2Client

show all

Defined in:: lib/google/cloud/logging/v2/config_service_v2_client.rb

Overview

Service for configuring sinks used to export log entries outside of Stackdriver Logging.

Constant Summary collapse

SERVICE_ADDRESS = The default address of the service.

"logging.googleapis.com".freeze

DEFAULT_SERVICE_PORT = The default port of the service.

DEFAULT_TIMEOUT =

ALL_SCOPES = The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform",
  "https://www.googleapis.com/auth/cloud-platform.read-only",
  "https://www.googleapis.com/auth/logging.admin",
  "https://www.googleapis.com/auth/logging.read",
  "https://www.googleapis.com/auth/logging.write"
].freeze

Instance Attribute Summary collapse

#config_service_v2_stub ⇒ Google::Logging::V2::ConfigServiceV2::Stub readonly

Class Method Summary collapse

.exclusion_path(project, exclusion) ⇒ String
Returns a fully-qualified exclusion resource name string.
.project_path(project) ⇒ String
Returns a fully-qualified project resource name string.
.sink_path(project, sink) ⇒ String
Returns a fully-qualified sink resource name string.

Instance Method Summary collapse

#create_exclusion(parent, exclusion, options: nil) ⇒ Google::Logging::V2::LogExclusion
Creates a new exclusion in a specified parent resource.
#create_sink(parent, sink, unique_writer_identity: nil, options: nil) ⇒ Google::Logging::V2::LogSink
Creates a sink that exports specified log entries to a destination.
#delete_exclusion(name, options: nil) ⇒ Object
Deletes an exclusion.
#delete_sink(sink_name, options: nil) ⇒ Object
Deletes a sink.
#get_exclusion(name, options: nil) ⇒ Google::Logging::V2::LogExclusion
Gets the description of an exclusion.
#get_sink(sink_name, options: nil) ⇒ Google::Logging::V2::LogSink
Gets a sink.
#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, lib_name: nil, lib_version: "") ⇒ ConfigServiceV2Client constructor
A new instance of ConfigServiceV2Client.
#list_exclusions(parent, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Logging::V2::LogExclusion>
Lists all the exclusions in a parent resource.
#list_sinks(parent, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Logging::V2::LogSink>
Lists sinks.
#update_exclusion(name, exclusion, update_mask, options: nil) ⇒ Google::Logging::V2::LogExclusion
Changes one or more properties of an existing exclusion.
#update_sink(sink_name, sink, unique_writer_identity: nil, update_mask: nil, options: nil) ⇒ Google::Logging::V2::LogSink
Updates a sink.

Constructor Details

#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, lib_name: nil, lib_version: "") ⇒ `ConfigServiceV2Client`

Returns a new instance of ConfigServiceV2Client

Parameters:

credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) —
Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.
scopes (Array<String>) —
The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.
client_config (Hash) —
A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.
timeout (Numeric) —
The default timeout, in seconds, for calls made through this client.

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 149

def initialize \
    service_path: SERVICE_ADDRESS,
    port: DEFAULT_SERVICE_PORT,
    channel: nil,
    chan_creds: nil,
    updater_proc: nil,
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/logging/v2/logging_config_services_pb"

  if channel || chan_creds || updater_proc
    warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
      "on 2017/09/08"
    credentials ||= channel
    credentials ||= chan_creds
    credentials ||= updater_proc
  end
  if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
    warn "`service_path` and `port` parameters are deprecated and will be removed"
  end

  credentials ||= Google::Cloud::Logging::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Logging::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/0.1.0 gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  client_config_file = Pathname.new(__dir__).join(
    "config_service_v2_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.logging.v2.ConfigServiceV2",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      kwargs: headers
    )
  end
  @config_service_v2_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    &Google::Logging::V2::ConfigServiceV2::Stub.method(:new)
  )

  @list_sinks = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:list_sinks),
    defaults["list_sinks"]
  )
  @get_sink = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:get_sink),
    defaults["get_sink"]
  )
  @create_sink = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:create_sink),
    defaults["create_sink"]
  )
  @update_sink = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:update_sink),
    defaults["update_sink"]
  )
  @delete_sink = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:delete_sink),
    defaults["delete_sink"]
  )
  @list_exclusions = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:list_exclusions),
    defaults["list_exclusions"]
  )
  @get_exclusion = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:get_exclusion),
    defaults["get_exclusion"]
  )
  @create_exclusion = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:create_exclusion),
    defaults["create_exclusion"]
  )
  @update_exclusion = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:update_exclusion),
    defaults["update_exclusion"]
  )
  @delete_exclusion = Google::Gax.create_api_call(
    @config_service_v2_stub.method(:delete_exclusion),
    defaults["delete_exclusion"]
  )
end

Instance Attribute Details

#config_service_v2_stub ⇒ `Google::Logging::V2::ConfigServiceV2::Stub` (readonly)

Returns:

(Google::Logging::V2::ConfigServiceV2::Stub)

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 42

class ConfigServiceV2Client
  attr_reader :config_service_v2_stub

  # The default address of the service.
  SERVICE_ADDRESS = "logging.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_sinks" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "sinks"),
    "list_exclusions" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "exclusions")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
    "https://www.googleapis.com/auth/cloud-platform",
    "https://www.googleapis.com/auth/cloud-platform.read-only",
    "https://www.googleapis.com/auth/logging.admin",
    "https://www.googleapis.com/auth/logging.read",
    "https://www.googleapis.com/auth/logging.write"
  ].freeze

  PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}"
  )

  private_constant :PROJECT_PATH_TEMPLATE

  SINK_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/sinks/{sink}"
  )

  private_constant :SINK_PATH_TEMPLATE

  EXCLUSION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/exclusions/{exclusion}"
  )

  private_constant :EXCLUSION_PATH_TEMPLATE

  # Returns a fully-qualified project resource name string.
  # @param project [String]
  # @return [String]
  def self.project_path project
    PROJECT_PATH_TEMPLATE.render(
      :"project" => project
    )
  end

  # Returns a fully-qualified sink resource name string.
  # @param project [String]
  # @param sink [String]
  # @return [String]
  def self.sink_path project, sink
    SINK_PATH_TEMPLATE.render(
      :"project" => project,
      :"sink" => sink
    )
  end

  # Returns a fully-qualified exclusion resource name string.
  # @param project [String]
  # @param exclusion [String]
  # @return [String]
  def self.exclusion_path project, exclusion
    EXCLUSION_PATH_TEMPLATE.render(
      :"project" => project,
      :"exclusion" => exclusion
    )
  end

  # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
  #   Provides the means for authenticating requests made by the client. This parameter can
  #   be many types.
  #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
  #   authenticating requests made by this client.
  #   A `String` will be treated as the path to the keyfile to be used for the construction of
  #   credentials for this client.
  #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
  #   credentials for this client.
  #   A `GRPC::Core::Channel` will be used to make calls through.
  #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
  #   should already be composed with a `GRPC::Core::CallCredentials` object.
  #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
  #   metadata for requests, generally, to give OAuth credentials.
  # @param scopes [Array<String>]
  #   The OAuth scopes for this service. This parameter is ignored if
  #   an updater_proc is supplied.
  # @param client_config [Hash]
  #   A Hash for call options for each method. See
  #   Google::Gax#construct_settings for the structure of
  #   this data. Falls back to the default config if not specified
  #   or the specified config is missing data points.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  def initialize \
      service_path: SERVICE_ADDRESS,
      port: DEFAULT_SERVICE_PORT,
      channel: nil,
      chan_creds: nil,
      updater_proc: nil,
      credentials: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      lib_name: nil,
      lib_version: ""
    # These require statements are intentionally placed here to initialize
    # the gRPC module only when it's required.
    # See https://github.com/googleapis/toolkit/issues/446
    require "google/gax/grpc"
    require "google/logging/v2/logging_config_services_pb"

    if channel || chan_creds || updater_proc
      warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
        "on 2017/09/08"
      credentials ||= channel
      credentials ||= chan_creds
      credentials ||= updater_proc
    end
    if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
      warn "`service_path` and `port` parameters are deprecated and will be removed"
    end

    credentials ||= Google::Cloud::Logging::Credentials.default

    if credentials.is_a?(String) || credentials.is_a?(Hash)
      updater_proc = Google::Cloud::Logging::Credentials.new(credentials).updater_proc
    end
    if credentials.is_a?(GRPC::Core::Channel)
      channel = credentials
    end
    if credentials.is_a?(GRPC::Core::ChannelCredentials)
      chan_creds = credentials
    end
    if credentials.is_a?(Proc)
      updater_proc = credentials
    end
    if credentials.is_a?(Google::Auth::Credentials)
      updater_proc = credentials.updater_proc
    end

    google_api_client = "gl-ruby/#{RUBY_VERSION}"
    google_api_client << " #{lib_name}/#{lib_version}" if lib_name
    google_api_client << " gapic/0.1.0 gax/#{Google::Gax::VERSION}"
    google_api_client << " grpc/#{GRPC::VERSION}"
    google_api_client.freeze

    headers = { :"x-goog-api-client" => google_api_client }
    client_config_file = Pathname.new(__dir__).join(
      "config_service_v2_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.logging.v2.ConfigServiceV2",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        page_descriptors: PAGE_DESCRIPTORS,
        errors: Google::Gax::Grpc::API_ERRORS,
        kwargs: headers
      )
    end
    @config_service_v2_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      &Google::Logging::V2::ConfigServiceV2::Stub.method(:new)
    )

    @list_sinks = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:list_sinks),
      defaults["list_sinks"]
    )
    @get_sink = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:get_sink),
      defaults["get_sink"]
    )
    @create_sink = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:create_sink),
      defaults["create_sink"]
    )
    @update_sink = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:update_sink),
      defaults["update_sink"]
    )
    @delete_sink = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:delete_sink),
      defaults["delete_sink"]
    )
    @list_exclusions = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:list_exclusions),
      defaults["list_exclusions"]
    )
    @get_exclusion = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:get_exclusion),
      defaults["get_exclusion"]
    )
    @create_exclusion = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:create_exclusion),
      defaults["create_exclusion"]
    )
    @update_exclusion = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:update_exclusion),
      defaults["update_exclusion"]
    )
    @delete_exclusion = Google::Gax.create_api_call(
      @config_service_v2_stub.method(:delete_exclusion),
      defaults["delete_exclusion"]
    )
  end

  # Service calls

  # Lists sinks.
  #
  # @param parent [String]
  #   Required. The parent resource whose sinks are to be listed:
  #
  #       "projects/[PROJECT_ID]"
  #       "organizations/[ORGANIZATION_ID]"
  #       "billingAccounts/[BILLING_ACCOUNT_ID]"
  #       "folders/[FOLDER_ID]"
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Logging::V2::LogSink>]
  #   An enumerable of Google::Logging::V2::LogSink instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2"
  #
  #   config_service_v2_client = Google::Cloud::Logging::V2::Config.new
  #   formatted_parent = Google::Cloud::Logging::V2::ConfigServiceV2Client.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   config_service_v2_client.list_sinks(formatted_parent).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   config_service_v2_client.list_sinks(formatted_parent).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_sinks \
      parent,
      page_size: nil,
      options: nil
    req = {
      parent: parent,
      page_size: page_size
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Logging::V2::ListSinksRequest)
    @list_sinks.call(req, options)
  end

  # Gets a sink.
  #
  # @param sink_name [String]
  #   Required. The resource name of the sink:
  #
  #       "projects/[PROJECT_ID]/sinks/[SINK_ID]"
  #       "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
  #       "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
  #       "folders/[FOLDER_ID]/sinks/[SINK_ID]"
  #
  #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Logging::V2::LogSink]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2"
  #
  #   config_service_v2_client = Google::Cloud::Logging::V2::Config.new
  #   formatted_sink_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
  #   response = config_service_v2_client.get_sink(formatted_sink_name)

  def get_sink \
      sink_name,
      options: nil
    req = {
      sink_name: sink_name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Logging::V2::GetSinkRequest)
    @get_sink.call(req, options)
  end

  # Creates a sink that exports specified log entries to a destination.  The
  # export of newly-ingested log entries begins immediately, unless 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 parent [String]
  #   Required. The resource in which to create the sink:
  #
  #       "projects/[PROJECT_ID]"
  #       "organizations/[ORGANIZATION_ID]"
  #       "billingAccounts/[BILLING_ACCOUNT_ID]"
  #       "folders/[FOLDER_ID]"
  #
  #   Examples: +"projects/my-logging-project"+, +"organizations/123456789"+.
  # @param sink [Google::Logging::V2::LogSink | Hash]
  #   Required. The new sink, whose +name+ parameter is a sink identifier that
  #   is not already in use.
  #   A hash of the same form as `Google::Logging::V2::LogSink`
  #   can also be provided.
  # @param unique_writer_identity [true, false]
  #   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
  #   the same group or service account used by Stackdriver Logging 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 {Google::Logging::V2::LogSink LogSink}.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Logging::V2::LogSink]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2"
  #
  #   config_service_v2_client = Google::Cloud::Logging::V2::Config.new
  #   formatted_parent = Google::Cloud::Logging::V2::ConfigServiceV2Client.project_path("[PROJECT]")
  #   sink = {}
  #   response = config_service_v2_client.create_sink(formatted_parent, sink)

  def create_sink \
      parent,
      sink,
      unique_writer_identity: nil,
      options: nil
    req = {
      parent: parent,
      sink: sink,
      unique_writer_identity: unique_writer_identity
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Logging::V2::CreateSinkRequest)
    @create_sink.call(req, options)
  end

  # Updates a sink.  This method replaces the following fields in the existing
  # sink with values from the new sink: +destination+, and +filter+.
  # The updated sink might also have a new +writer_identity+; see the
  # +unique_writer_identity+ field.
  #
  # @param sink_name [String]
  #   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]"
  #       "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
  #       "folders/[FOLDER_ID]/sinks/[SINK_ID]"
  #
  #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
  # @param sink [Google::Logging::V2::LogSink | Hash]
  #   Required. The updated sink, whose name is the same identifier that appears
  #   as part of +sink_name+.
  #   A hash of the same form as `Google::Logging::V2::LogSink`
  #   can also be provided.
  # @param unique_writer_identity [true, false]
  #   Optional. See
  #   [sinks.create](https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.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 is 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 is true and the new value is
  #     set to false or defaulted to false.
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
  #   Optional. Field mask that specifies the fields in +sink+ that need
  #   an update. A sink field will be overwritten if, and only if, it is
  #   in the update mask.  +name+ and output only fields cannot be updated.
  #
  #   An empty updateMask is temporarily treated as using the following mask
  #   for backwards compatibility purposes:
  #     destination,filter,includeChildren
  #   At some point in the future, behavior will be removed and specifying an
  #   empty updateMask will be an error.
  #
  #   For a detailed +FieldMask+ definition, see
  #   https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
  #
  #   Example: +updateMask=filter+.
  #   A hash of the same form as `Google::Protobuf::FieldMask`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Logging::V2::LogSink]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2"
  #
  #   config_service_v2_client = Google::Cloud::Logging::V2::Config.new
  #   formatted_sink_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
  #   sink = {}
  #   response = config_service_v2_client.update_sink(formatted_sink_name, sink)

  def update_sink \
      sink_name,
      sink,
      unique_writer_identity: nil,
      update_mask: nil,
      options: nil
    req = {
      sink_name: sink_name,
      sink: sink,
      unique_writer_identity: unique_writer_identity,
      update_mask: update_mask
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Logging::V2::UpdateSinkRequest)
    @update_sink.call(req, options)
  end

  # Deletes a sink. If the sink has a unique +writer_identity+, then that
  # service account is also deleted.
  #
  # @param sink_name [String]
  #   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]"
  #       "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
  #       "folders/[FOLDER_ID]/sinks/[SINK_ID]"
  #
  #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2"
  #
  #   config_service_v2_client = Google::Cloud::Logging::V2::Config.new
  #   formatted_sink_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
  #   config_service_v2_client.delete_sink(formatted_sink_name)

  def delete_sink \
      sink_name,
      options: nil
    req = {
      sink_name: sink_name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Logging::V2::DeleteSinkRequest)
    @delete_sink.call(req, options)
    nil
  end

  # Lists all the exclusions in a parent resource.
  #
  # @param parent [String]
  #   Required. The parent resource whose exclusions are to be listed.
  #
  #       "projects/[PROJECT_ID]"
  #       "organizations/[ORGANIZATION_ID]"
  #       "billingAccounts/[BILLING_ACCOUNT_ID]"
  #       "folders/[FOLDER_ID]"
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Logging::V2::LogExclusion>]
  #   An enumerable of Google::Logging::V2::LogExclusion instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2"
  #
  #   config_service_v2_client = Google::Cloud::Logging::V2::Config.new
  #   formatted_parent = Google::Cloud::Logging::V2::ConfigServiceV2Client.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   config_service_v2_client.list_exclusions(formatted_parent).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   config_service_v2_client.list_exclusions(formatted_parent).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_exclusions \
      parent,
      page_size: nil,
      options: nil
    req = {
      parent: parent,
      page_size: page_size
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Logging::V2::ListExclusionsRequest)
    @list_exclusions.call(req, options)
  end

  # Gets the description of an exclusion.
  #
  # @param name [String]
  #   Required. The resource name of an existing exclusion:
  #
  #       "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
  #       "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
  #       "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
  #       "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
  #
  #   Example: +"projects/my-project-id/exclusions/my-exclusion-id"+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Logging::V2::LogExclusion]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2"
  #
  #   config_service_v2_client = Google::Cloud::Logging::V2::Config.new
  #   formatted_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.exclusion_path("[PROJECT]", "[EXCLUSION]")
  #   response = config_service_v2_client.get_exclusion(formatted_name)

  def get_exclusion \
      name,
      options: nil
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Logging::V2::GetExclusionRequest)
    @get_exclusion.call(req, options)
  end

  # Creates a new exclusion in a specified parent resource.
  # Only log entries belonging to that resource can be excluded.
  # You can have up to 10 exclusions in a resource.
  #
  # @param parent [String]
  #   Required. The parent resource in which to create the exclusion:
  #
  #       "projects/[PROJECT_ID]"
  #       "organizations/[ORGANIZATION_ID]"
  #       "billingAccounts/[BILLING_ACCOUNT_ID]"
  #       "folders/[FOLDER_ID]"
  #
  #   Examples: +"projects/my-logging-project"+, +"organizations/123456789"+.
  # @param exclusion [Google::Logging::V2::LogExclusion | Hash]
  #   Required. The new exclusion, whose +name+ parameter is an exclusion name
  #   that is not already used in the parent resource.
  #   A hash of the same form as `Google::Logging::V2::LogExclusion`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Logging::V2::LogExclusion]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2"
  #
  #   config_service_v2_client = Google::Cloud::Logging::V2::Config.new
  #   formatted_parent = Google::Cloud::Logging::V2::ConfigServiceV2Client.project_path("[PROJECT]")
  #   exclusion = {}
  #   response = config_service_v2_client.create_exclusion(formatted_parent, exclusion)

  def create_exclusion \
      parent,
      exclusion,
      options: nil
    req = {
      parent: parent,
      exclusion: exclusion
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Logging::V2::CreateExclusionRequest)
    @create_exclusion.call(req, options)
  end

  # Changes one or more properties of an existing exclusion.
  #
  # @param name [String]
  #   Required. The resource name of the exclusion to update:
  #
  #       "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
  #       "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
  #       "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
  #       "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
  #
  #   Example: +"projects/my-project-id/exclusions/my-exclusion-id"+.
  # @param exclusion [Google::Logging::V2::LogExclusion | Hash]
  #   Required. New values for the existing exclusion. Only the fields specified
  #   in +update_mask+ are relevant.
  #   A hash of the same form as `Google::Logging::V2::LogExclusion`
  #   can also be provided.
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
  #   Required. A nonempty list of fields to change in the existing exclusion.
  #   New values for the fields are taken from the corresponding fields in the
  #   {Google::Logging::V2::LogExclusion LogExclusion} included in this request. Fields not mentioned in
  #   +update_mask+ are not changed and are ignored in the request.
  #
  #   For example, to change the filter and description of an exclusion,
  #   specify an +update_mask+ of +"filter,description"+.
  #   A hash of the same form as `Google::Protobuf::FieldMask`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Logging::V2::LogExclusion]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2"
  #
  #   config_service_v2_client = Google::Cloud::Logging::V2::Config.new
  #   formatted_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.exclusion_path("[PROJECT]", "[EXCLUSION]")
  #   exclusion = {}
  #   update_mask = {}
  #   response = config_service_v2_client.update_exclusion(formatted_name, exclusion, update_mask)

  def update_exclusion \
      name,
      exclusion,
      update_mask,
      options: nil
    req = {
      name: name,
      exclusion: exclusion,
      update_mask: update_mask
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Logging::V2::UpdateExclusionRequest)
    @update_exclusion.call(req, options)
  end

  # Deletes an exclusion.
  #
  # @param name [String]
  #   Required. The resource name of an existing exclusion to delete:
  #
  #       "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
  #       "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
  #       "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
  #       "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
  #
  #   Example: +"projects/my-project-id/exclusions/my-exclusion-id"+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2"
  #
  #   config_service_v2_client = Google::Cloud::Logging::V2::Config.new
  #   formatted_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.exclusion_path("[PROJECT]", "[EXCLUSION]")
  #   config_service_v2_client.delete_exclusion(formatted_name)

  def delete_exclusion \
      name,
      options: nil
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Logging::V2::DeleteExclusionRequest)
    @delete_exclusion.call(req, options)
    nil
  end
end

Class Method Details

.exclusion_path(project, exclusion) ⇒ `String`

Returns a fully-qualified exclusion resource name string.

Parameters:

project (String)
exclusion (String)

Returns:

(String)

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 118

def self.exclusion_path project, exclusion
  EXCLUSION_PATH_TEMPLATE.render(
    :"project" => project,
    :"exclusion" => exclusion
  )
end

.project_path(project) ⇒ `String`

Returns a fully-qualified project resource name string.

Parameters:

project (String)

Returns:

(String)

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 97

def self.project_path project
  PROJECT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

.sink_path(project, sink) ⇒ `String`

Returns a fully-qualified sink resource name string.

Parameters:

project (String)
sink (String)

Returns:

(String)

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 107

def self.sink_path project, sink
  SINK_PATH_TEMPLATE.render(
    :"project" => project,
    :"sink" => sink
  )
end

Instance Method Details

#create_exclusion(parent, exclusion, options: nil) ⇒ `Google::Logging::V2::LogExclusion`

Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::Config.new
formatted_parent = Google::Cloud::Logging::V2::ConfigServiceV2Client.project_path("[PROJECT]")
exclusion = {}
response = config_service_v2_client.create_exclusion(formatted_parent, exclusion)

Parameters:

parent (String) —
Required. The parent resource in which to create the exclusion:
```
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
```
Examples: +"projects/my-logging-project"+, +"organizations/123456789"+.
exclusion (Google::Logging::V2::LogExclusion | Hash) —
Required. The new exclusion, whose +name+ parameter is an exclusion name that is not already used in the parent resource. A hash of the same form as Google::Logging::V2::LogExclusion can also be provided.
options (Google::Gax::CallOptions) —
Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

(Google::Logging::V2::LogExclusion)

Raises:

(Google::Gax::GaxError) —
if the RPC is aborted.

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 651

def create_exclusion \
    parent,
    exclusion,
    options: nil
  req = {
    parent: parent,
    exclusion: exclusion
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::CreateExclusionRequest)
  @create_exclusion.call(req, options)
end

#create_sink(parent, sink, unique_writer_identity: nil, options: nil) ⇒ `Google::Logging::V2::LogSink`

Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless 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.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::Config.new
formatted_parent = Google::Cloud::Logging::V2::ConfigServiceV2Client.project_path("[PROJECT]")
sink = {}
response = config_service_v2_client.create_sink(formatted_parent, sink)

Parameters:

parent (String) —
Required. The resource in which to create the sink:
```
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
```
Examples: +"projects/my-logging-project"+, +"organizations/123456789"+.
sink (Google::Logging::V2::LogSink | Hash) —
Required. The new sink, whose +name+ parameter is a sink identifier that is not already in use. A hash of the same form as Google::Logging::V2::LogSink can also be provided.
unique_writer_identity (true, false) —
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 the same group or service account used by Stackdriver Logging 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.
options (Google::Gax::CallOptions) —
Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

(Google::Logging::V2::LogSink)

Raises:

(Google::Gax::GaxError) —
if the RPC is aborted.

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 404

def create_sink \
    parent,
    sink,
    unique_writer_identity: nil,
    options: nil
  req = {
    parent: parent,
    sink: sink,
    unique_writer_identity: unique_writer_identity
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::CreateSinkRequest)
  @create_sink.call(req, options)
end

#delete_exclusion(name, options: nil) ⇒ `Object`

Deletes an exclusion.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::Config.new
formatted_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.exclusion_path("[PROJECT]", "[EXCLUSION]")
config_service_v2_client.delete_exclusion(formatted_name)

Parameters:

name (String) —

Required. The resource name of an existing exclusion to delete:

"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"

Example: +"projects/my-project-id/exclusions/my-exclusion-id"+.

options (Google::Gax::CallOptions) —
Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

(Google::Gax::GaxError) —
if the RPC is aborted.

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 739

def delete_exclusion \
    name,
    options: nil
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::DeleteExclusionRequest)
  @delete_exclusion.call(req, options)
  nil
end

#delete_sink(sink_name, options: nil) ⇒ `Object`

Deletes a sink. If the sink has a unique +writer_identity+, then that service account is also deleted.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::Config.new
formatted_sink_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
config_service_v2_client.delete_sink(formatted_sink_name)

Parameters:

sink_name (String) —

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]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"

Example: +"projects/my-project-id/sinks/my-sink-id"+.

options (Google::Gax::CallOptions) —
Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

(Google::Gax::GaxError) —
if the RPC is aborted.

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 521

def delete_sink \
    sink_name,
    options: nil
  req = {
    sink_name: sink_name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::DeleteSinkRequest)
  @delete_sink.call(req, options)
  nil
end

#get_exclusion(name, options: nil) ⇒ `Google::Logging::V2::LogExclusion`

Gets the description of an exclusion.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::Config.new
formatted_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.exclusion_path("[PROJECT]", "[EXCLUSION]")
response = config_service_v2_client.get_exclusion(formatted_name)

Parameters:

name (String) —

Required. The resource name of an existing exclusion:

"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"

Example: +"projects/my-project-id/exclusions/my-exclusion-id"+.

options (Google::Gax::CallOptions) —
Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

(Google::Logging::V2::LogExclusion)

Raises:

(Google::Gax::GaxError) —
if the RPC is aborted.

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 610

def get_exclusion \
    name,
    options: nil
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::GetExclusionRequest)
  @get_exclusion.call(req, options)
end

#get_sink(sink_name, options: nil) ⇒ `Google::Logging::V2::LogSink`

Gets a sink.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::Config.new
formatted_sink_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
response = config_service_v2_client.get_sink(formatted_sink_name)

Parameters:

sink_name (String) —

Required. The resource name of the sink:

"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"

Example: +"projects/my-project-id/sinks/my-sink-id"+.

options (Google::Gax::CallOptions) —
Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

(Google::Logging::V2::LogSink)

Raises:

(Google::Gax::GaxError) —
if the RPC is aborted.

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 350

def get_sink \
    sink_name,
    options: nil
  req = {
    sink_name: sink_name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::GetSinkRequest)
  @get_sink.call(req, options)
end

#list_exclusions(parent, page_size: nil, options: nil) ⇒ `Google::Gax::PagedEnumerable<Google::Logging::V2::LogExclusion>`

Lists all the exclusions in a parent resource.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::Config.new
formatted_parent = Google::Cloud::Logging::V2::ConfigServiceV2Client.project_path("[PROJECT]")

# Iterate over all results.
config_service_v2_client.list_exclusions(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
config_service_v2_client.list_exclusions(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

parent (String) —

Required. The parent resource whose exclusions are to be listed.

"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"

page_size (Integer) —
The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options (Google::Gax::CallOptions) —
Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

(Google::Gax::PagedEnumerable<Google::Logging::V2::LogExclusion>) —
An enumerable of Google::Logging::V2::LogExclusion instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

(Google::Gax::GaxError) —
if the RPC is aborted.

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 575

def list_exclusions \
    parent,
    page_size: nil,
    options: nil
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::ListExclusionsRequest)
  @list_exclusions.call(req, options)
end

#list_sinks(parent, page_size: nil, options: nil) ⇒ `Google::Gax::PagedEnumerable<Google::Logging::V2::LogSink>`

Lists sinks.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::Config.new
formatted_parent = Google::Cloud::Logging::V2::ConfigServiceV2Client.project_path("[PROJECT]")

# Iterate over all results.
config_service_v2_client.list_sinks(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
config_service_v2_client.list_sinks(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

parent (String) —

Required. The parent resource whose sinks are to be listed:

"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"

page_size (Integer) —
The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options (Google::Gax::CallOptions) —
Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

(Google::Gax::PagedEnumerable<Google::Logging::V2::LogSink>) —
An enumerable of Google::Logging::V2::LogSink instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

(Google::Gax::GaxError) —
if the RPC is aborted.

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 315

def list_sinks \
    parent,
    page_size: nil,
    options: nil
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::ListSinksRequest)
  @list_sinks.call(req, options)
end

#update_exclusion(name, exclusion, update_mask, options: nil) ⇒ `Google::Logging::V2::LogExclusion`

Changes one or more properties of an existing exclusion.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::Config.new
formatted_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.exclusion_path("[PROJECT]", "[EXCLUSION]")
exclusion = {}
update_mask = {}
response = config_service_v2_client.update_exclusion(formatted_name, exclusion, update_mask)

Parameters:

name (String) —

Required. The resource name of the exclusion to update:

"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"

Example: +"projects/my-project-id/exclusions/my-exclusion-id"+.

exclusion (Google::Logging::V2::LogExclusion | Hash) —
Required. New values for the existing exclusion. Only the fields specified in +update_mask+ are relevant. A hash of the same form as Google::Logging::V2::LogExclusion can also be provided.
update_mask (Google::Protobuf::FieldMask | Hash) —
Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in +update_mask+ are not changed and are ignored in the request.

For example, to change the filter and description of an exclusion, specify an +update_mask+ of +"filter,description"+. A hash of the same form as Google::Protobuf::FieldMask can also be provided.
options (Google::Gax::CallOptions) —
Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

(Google::Logging::V2::LogExclusion)

Raises:

(Google::Gax::GaxError) —
if the RPC is aborted.

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 703

def update_exclusion \
    name,
    exclusion,
    update_mask,
    options: nil
  req = {
    name: name,
    exclusion: exclusion,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::UpdateExclusionRequest)
  @update_exclusion.call(req, options)
end

#update_sink(sink_name, sink, unique_writer_identity: nil, update_mask: nil, options: nil) ⇒ `Google::Logging::V2::LogSink`

Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: +destination+, and +filter+. The updated sink might also have a new +writer_identity+; see the +unique_writer_identity+ field.

Examples:

require "google/cloud/logging/v2"

config_service_v2_client = Google::Cloud::Logging::V2::Config.new
formatted_sink_name = Google::Cloud::Logging::V2::ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
sink = {}
response = config_service_v2_client.update_sink(formatted_sink_name, sink)

Parameters:

sink_name (String) —

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]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"

Example: +"projects/my-project-id/sinks/my-sink-id"+.

sink (Google::Logging::V2::LogSink | Hash) —
Required. The updated sink, whose name is the same identifier that appears as part of +sink_name+. A hash of the same form as Google::Logging::V2::LogSink can also be provided.
unique_writer_identity (true, false) —
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 is 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 is true and the new value is set to false or defaulted to false.
update_mask (Google::Protobuf::FieldMask | Hash) —
Optional. Field mask that specifies the fields in +sink+ that need an update. A sink field will be overwritten if, and only if, it is in the update mask. +name+ and output only fields cannot be updated.

An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.

For a detailed +FieldMask+ definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Example: +updateMask=filter+. A hash of the same form as Google::Protobuf::FieldMask can also be provided.
options (Google::Gax::CallOptions) —
Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

(Google::Logging::V2::LogSink)

Raises:

(Google::Gax::GaxError) —
if the RPC is aborted.

# File 'lib/google/cloud/logging/v2/config_service_v2_client.rb', line 481

def update_sink \
    sink_name,
    sink,
    unique_writer_identity: nil,
    update_mask: nil,
    options: nil
  req = {
    sink_name: sink_name,
    sink: sink,
    unique_writer_identity: unique_writer_identity,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Logging::V2::UpdateSinkRequest)
  @update_sink.call(req, options)
end

Class: Google::Cloud::Logging::V2::ConfigServiceV2Client

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, lib_name: nil, lib_version: "") ⇒ ConfigServiceV2Client

Instance Attribute Details

#config_service_v2_stub ⇒ Google::Logging::V2::ConfigServiceV2::Stub (readonly)

Class Method Details

.exclusion_path(project, exclusion) ⇒ String

.project_path(project) ⇒ String

.sink_path(project, sink) ⇒ String

Instance Method Details

#create_exclusion(parent, exclusion, options: nil) ⇒ Google::Logging::V2::LogExclusion

#create_sink(parent, sink, unique_writer_identity: nil, options: nil) ⇒ Google::Logging::V2::LogSink

#delete_exclusion(name, options: nil) ⇒ Object

#delete_sink(sink_name, options: nil) ⇒ Object

#get_exclusion(name, options: nil) ⇒ Google::Logging::V2::LogExclusion

#get_sink(sink_name, options: nil) ⇒ Google::Logging::V2::LogSink

#list_exclusions(parent, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Logging::V2::LogExclusion>

#list_sinks(parent, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Logging::V2::LogSink>

#update_exclusion(name, exclusion, update_mask, options: nil) ⇒ Google::Logging::V2::LogExclusion

#update_sink(sink_name, sink, unique_writer_identity: nil, update_mask: nil, options: nil) ⇒ Google::Logging::V2::LogSink

#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, lib_name: nil, lib_version: "") ⇒ `ConfigServiceV2Client`

#config_service_v2_stub ⇒ `Google::Logging::V2::ConfigServiceV2::Stub` (readonly)

.exclusion_path(project, exclusion) ⇒ `String`

.project_path(project) ⇒ `String`

.sink_path(project, sink) ⇒ `String`

#create_exclusion(parent, exclusion, options: nil) ⇒ `Google::Logging::V2::LogExclusion`

#create_sink(parent, sink, unique_writer_identity: nil, options: nil) ⇒ `Google::Logging::V2::LogSink`

#delete_exclusion(name, options: nil) ⇒ `Object`

#delete_sink(sink_name, options: nil) ⇒ `Object`

#get_exclusion(name, options: nil) ⇒ `Google::Logging::V2::LogExclusion`

#get_sink(sink_name, options: nil) ⇒ `Google::Logging::V2::LogSink`

#list_exclusions(parent, page_size: nil, options: nil) ⇒ `Google::Gax::PagedEnumerable<Google::Logging::V2::LogExclusion>`

#list_sinks(parent, page_size: nil, options: nil) ⇒ `Google::Gax::PagedEnumerable<Google::Logging::V2::LogSink>`

#update_exclusion(name, exclusion, update_mask, options: nil) ⇒ `Google::Logging::V2::LogExclusion`

#update_sink(sink_name, sink, unique_writer_identity: nil, update_mask: nil, options: nil) ⇒ `Google::Logging::V2::LogSink`