Class: Google::Cloud::Logging::V2::ConfigService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/logging/v2/config_service/client.rb

Overview

Client for the ConfigService service.

Service for configuring sinks used to route log entries.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#billing_account_location_path, #billing_account_path, #cmek_settings_path, #folder_location_path, #folder_path, #location_path, #log_bucket_path, #log_exclusion_path, #log_sink_path, #organization_location_path, #organization_path, #project_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new ConfigService client object.

Examples

To create a new ConfigService client with the default configuration:

client = ::Google::Cloud::Logging::V2::ConfigService::Client.new

To create a new ConfigService client with a custom configuration:

client = ::Google::Cloud::Logging::V2::ConfigService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the ConfigService client.

Yield Parameters:



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 176

def initialize
  # 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 "gapic/grpc"
  require "google/logging/v2/logging_config_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  credentials ||= Credentials.default scope: @config.scope
  if credentials.is_a?(String) || credentials.is_a?(Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @config_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Logging::V2::ConfigServiceV2::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the ConfigService Client class.

See Configuration for a description of the configuration fields.

Example

To modify the configuration for all ConfigService clients:

::Google::Cloud::Logging::V2::ConfigService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 57

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Logging", "V2"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const&.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.list_sinks.timeout = 60.0
    default_config.rpcs.list_sinks.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [4, 13, 14]
    }

    default_config.rpcs.get_sink.timeout = 60.0
    default_config.rpcs.get_sink.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [4, 13, 14]
    }

    default_config.rpcs.create_sink.timeout = 120.0

    default_config.rpcs.update_sink.timeout = 60.0
    default_config.rpcs.update_sink.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [4, 13, 14]
    }

    default_config.rpcs.delete_sink.timeout = 60.0
    default_config.rpcs.delete_sink.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [4, 13, 14]
    }

    default_config.rpcs.list_exclusions.timeout = 60.0
    default_config.rpcs.list_exclusions.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [4, 13, 14]
    }

    default_config.rpcs.get_exclusion.timeout = 60.0
    default_config.rpcs.get_exclusion.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [4, 13, 14]
    }

    default_config.rpcs.create_exclusion.timeout = 120.0

    default_config.rpcs.update_exclusion.timeout = 120.0

    default_config.rpcs.delete_exclusion.timeout = 60.0
    default_config.rpcs.delete_exclusion.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   [4, 13, 14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the ConfigService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



151
152
153
154
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 151

def configure
  yield @config if block_given?
  @config
end

#create_exclusion(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogExclusion #create_exclusion(parent: nil, exclusion: nil) ⇒ ::Google::Cloud::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.

Overloads:

  • #create_exclusion(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogExclusion

    Pass arguments to create_exclusion via a request object, either of type Google::Cloud::Logging::V2::CreateExclusionRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::CreateExclusionRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

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

    Pass arguments to create_exclusion via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      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::Cloud::Logging::V2::LogExclusion, ::Hash) (defaults to: nil) —

      Required. The new exclusion, whose name parameter is an exclusion name that is not already used in the parent resource.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 1088

def create_exclusion request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::CreateExclusionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_exclusion.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_exclusion.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_exclusion.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :create_exclusion, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_sink(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogSink #create_sink(parent: nil, sink: nil, unique_writer_identity: nil) ⇒ ::Google::Cloud::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.

Overloads:

  • #create_sink(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogSink

    Pass arguments to create_sink via a request object, either of type Google::Cloud::Logging::V2::CreateSinkRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::CreateSinkRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

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

    Pass arguments to create_sink via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      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::Cloud::Logging::V2::LogSink, ::Hash) (defaults to: nil) —

      Required. The new sink, whose name parameter is a sink identifier that is not already in use.

    • unique_writer_identity (::Boolean) (defaults to: nil) —

      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 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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 673

def create_sink request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::CreateSinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_sink.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_sink.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_sink.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :create_sink, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_exclusion(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_exclusion(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes an exclusion.

Overloads:

  • #delete_exclusion(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_exclusion via a request object, either of type DeleteExclusionRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::DeleteExclusionRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_exclusion(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_exclusion via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      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".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 1245

def delete_exclusion request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::DeleteExclusionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_exclusion.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_exclusion.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_exclusion.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :delete_exclusion, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_sink(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_sink(sink_name: nil) ⇒ ::Google::Protobuf::Empty

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

Overloads:

  • #delete_sink(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_sink via a request object, either of type DeleteSinkRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::DeleteSinkRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_sink(sink_name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_sink via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • sink_name (::String) (defaults to: nil) —

      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".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 856

def delete_sink request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::DeleteSinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_sink.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "sink_name" => request.sink_name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_sink.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_sink.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :delete_sink, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_bucket(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogBucket #get_bucket(name: nil) ⇒ ::Google::Cloud::Logging::V2::LogBucket

Gets a bucket (Beta).

Overloads:

  • #get_bucket(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogBucket

    Pass arguments to get_bucket via a request object, either of type GetBucketRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::GetBucketRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_bucket(name: nil) ⇒ ::Google::Cloud::Logging::V2::LogBucket

    Pass arguments to get_bucket via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The resource name of the bucket:

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"

      Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 331

def get_bucket request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::GetBucketRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_bucket.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_bucket.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_bucket.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :get_bucket, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_cmek_settings(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::CmekSettings #get_cmek_settings(name: nil) ⇒ ::Google::Cloud::Logging::V2::CmekSettings

Gets the Logs Router CMEK settings for the given resource.

Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.

See Enabling CMEK for Logs Router for more information.

Overloads:

  • #get_cmek_settings(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::CmekSettings

    Pass arguments to get_cmek_settings via a request object, either of type GetCmekSettingsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::GetCmekSettingsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_cmek_settings(name: nil) ⇒ ::Google::Cloud::Logging::V2::CmekSettings

    Pass arguments to get_cmek_settings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The resource for which to retrieve CMEK settings.

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

      Example: "organizations/12345/cmekSettings".

      Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 1330

def get_cmek_settings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::GetCmekSettingsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_cmek_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_cmek_settings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_cmek_settings.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :get_cmek_settings, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Gets the description of an exclusion.

Overloads:

  • #get_exclusion(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogExclusion

    Pass arguments to get_exclusion via a request object, either of type GetExclusionRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::GetExclusionRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_exclusion(name: nil) ⇒ ::Google::Cloud::Logging::V2::LogExclusion

    Pass arguments to get_exclusion via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      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".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 1010

def get_exclusion request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::GetExclusionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_exclusion.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_exclusion.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_exclusion.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :get_exclusion, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Gets a sink.

Overloads:

  • #get_sink(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogSink

    Pass arguments to get_sink via a request object, either of type GetSinkRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::GetSinkRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_sink(sink_name: nil) ⇒ ::Google::Cloud::Logging::V2::LogSink

    Pass arguments to get_sink via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • sink_name (::String) (defaults to: nil) —

      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".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 582

def get_sink request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::GetSinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_sink.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "sink_name" => request.sink_name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_sink.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_sink.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :get_sink, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_buckets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogBucket> #list_buckets(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogBucket>

Lists buckets (Beta).

Overloads:

  • #list_buckets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogBucket>

    Pass arguments to list_buckets via a request object, either of type ListBucketsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::ListBucketsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_buckets(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogBucket>

    Pass arguments to list_buckets via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

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

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

      Note: The locations portion of the resource must be specified, but supplying the character - in place of [LOCATION_ID] will return all buckets.

    • page_token (::String) (defaults to: nil) —

      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.

    • page_size (::Integer) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 256

def list_buckets request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::ListBucketsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_buckets.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_buckets.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_buckets.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :list_buckets, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @config_service_stub, :list_buckets, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_exclusions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogExclusion> #list_exclusions(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogExclusion>

Lists all the exclusions in a parent resource.

Overloads:

  • #list_exclusions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogExclusion>

    Pass arguments to list_exclusions via a request object, either of type ListExclusionsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::ListExclusionsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_exclusions(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogExclusion>

    Pass arguments to list_exclusions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

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

      "projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
    • page_token (::String) (defaults to: nil) —

      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.

    • page_size (::Integer) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 936

def list_exclusions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::ListExclusionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_exclusions.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_exclusions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_exclusions.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :list_exclusions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @config_service_stub, :list_exclusions, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_sinks(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogSink> #list_sinks(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogSink>

Lists sinks.

Overloads:

  • #list_sinks(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogSink>

    Pass arguments to list_sinks via a request object, either of type ListSinksRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::ListSinksRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_sinks(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogSink>

    Pass arguments to list_sinks via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

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

      "projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
    • page_token (::String) (defaults to: nil) —

      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.

    • page_size (::Integer) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 508

def list_sinks request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::ListSinksRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_sinks.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_sinks.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_sinks.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :list_sinks, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @config_service_stub, :list_sinks, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_bucket(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogBucket #update_bucket(name: nil, bucket: nil, update_mask: nil) ⇒ ::Google::Cloud::Logging::V2::LogBucket

Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_period

If the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.

If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.

A buckets region may not be modified after it is created. This method is in Beta.

Overloads:

  • #update_bucket(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogBucket

    Pass arguments to update_bucket via a request object, either of type UpdateBucketRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::UpdateBucketRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_bucket(name: nil, bucket: nil, update_mask: nil) ⇒ ::Google::Cloud::Logging::V2::LogBucket

    Pass arguments to update_bucket via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The full resource name of the bucket to update.

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"

      Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". Also requires permission "resourcemanager.projects.updateLiens" to set the locked property

    • bucket (::Google::Cloud::Logging::V2::LogBucket, ::Hash) (defaults to: nil) —

      Required. The updated bucket.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.

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

      Example: updateMask=retention_days.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 428

def update_bucket request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::UpdateBucketRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_bucket.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_bucket.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_bucket.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :update_bucket, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_cmek_settings(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::CmekSettings #update_cmek_settings(name: nil, cmek_settings: nil, update_mask: nil) ⇒ ::Google::Cloud::Logging::V2::CmekSettings

Updates the Logs Router CMEK settings for the given resource.

Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.

UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.

See Enabling CMEK for Logs Router for more information.

Overloads:

  • #update_cmek_settings(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::CmekSettings

    Pass arguments to update_cmek_settings via a request object, either of type UpdateCmekSettingsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::UpdateCmekSettingsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_cmek_settings(name: nil, cmek_settings: nil, update_mask: nil) ⇒ ::Google::Cloud::Logging::V2::CmekSettings

    Pass arguments to update_cmek_settings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The resource name for the CMEK settings to update.

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

      Example: "organizations/12345/cmekSettings".

      Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.

    • cmek_settings (::Google::Cloud::Logging::V2::CmekSettings, ::Hash) (defaults to: nil) —

      Required. The CMEK settings to update.

      See Enabling CMEK for Logs Router for more information.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. Field mask identifying which fields from cmek_settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.

      See FieldMask for more information.

      Example: "updateMask=kmsKeyName"

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 1435

def update_cmek_settings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::UpdateCmekSettingsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_cmek_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_cmek_settings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_cmek_settings.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :update_cmek_settings, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Changes one or more properties of an existing exclusion.

Overloads:

  • #update_exclusion(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogExclusion

    Pass arguments to update_exclusion via a request object, either of type UpdateExclusionRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::UpdateExclusionRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

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

    Pass arguments to update_exclusion via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      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::Cloud::Logging::V2::LogExclusion, ::Hash) (defaults to: nil) —

      Required. New values for the existing exclusion. Only the fields specified in update_mask are relevant.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. A non-empty 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".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 1172

def update_exclusion request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::UpdateExclusionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_exclusion.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_exclusion.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_exclusion.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :update_exclusion, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_sink(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogSink #update_sink(sink_name: nil, sink: nil, unique_writer_identity: nil, update_mask: nil) ⇒ ::Google::Cloud::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.

Overloads:

  • #update_sink(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::LogSink

    Pass arguments to update_sink via a request object, either of type UpdateSinkRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Logging::V2::UpdateSinkRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

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

    Pass arguments to update_sink via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • sink_name (::String) (defaults to: nil) —

      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::Cloud::Logging::V2::LogSink, ::Hash) (defaults to: nil) —

      Required. The updated sink, whose name is the same identifier that appears as part of sink_name.

    • unique_writer_identity (::Boolean) (defaults to: nil) —

      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) (defaults to: nil) —

      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#google.protobuf.FieldMask

      Example: updateMask=filter.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/google/cloud/logging/v2/config_service/client.rb', line 781

def update_sink request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::UpdateSinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_sink.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Logging::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "sink_name" => request.sink_name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_sink.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_sink.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_service_stub.call_rpc :update_sink, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end