Class: Google::Cloud::CloudControlsPartner::V1::CloudControlsPartnerMonitoring::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_monitoring/client.rb

Overview

Client for the CloudControlsPartnerMonitoring service.

Service describing handlers for resources

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#violation_path, #workload_path

Constructor Details

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

Create a new CloudControlsPartnerMonitoring client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::CloudControlsPartner::V1::CloudControlsPartnerMonitoring::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::CloudControlsPartner::V1::CloudControlsPartnerMonitoring::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the CloudControlsPartnerMonitoring client.

Yield Parameters:



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_monitoring/client.rb', line 134

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/cloud/cloudcontrolspartner/v1/monitoring_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
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  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

  @cloud_controls_partner_monitoring_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::CloudControlsPartner::V1::CloudControlsPartnerMonitoring::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Class Method Details

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

Configure the CloudControlsPartnerMonitoring Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all CloudControlsPartnerMonitoring clients
::Google::Cloud::CloudControlsPartner::V1::CloudControlsPartnerMonitoring::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
 
# File 'lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_monitoring/client.rb', line 62

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "CloudControlsPartner", "V1"]
    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_violations.timeout = 60.0
    default_config.rpcs.list_violations.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_violation.timeout = 60.0
    default_config.rpcs.get_violation.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the CloudControlsPartnerMonitoring 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:



104
105
106
107
 
# File 'lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_monitoring/client.rb', line 104

def configure
  yield @config if block_given?
  @config
end

#get_violation(request, options = nil) ⇒ ::Google::Cloud::CloudControlsPartner::V1::Violation #get_violation(name: nil) ⇒ ::Google::Cloud::CloudControlsPartner::V1::Violation

Gets details of a single Violation.

Examples:

Basic example

require "google/cloud/cloud_controls_partner/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CloudControlsPartner::V1::CloudControlsPartnerMonitoring::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CloudControlsPartner::V1::GetViolationRequest.new

# Call the get_violation method.
result = client.get_violation request

# The returned object is of type Google::Cloud::CloudControlsPartner::V1::Violation.
p result

Overloads:

  • #get_violation(request, options = nil) ⇒ ::Google::Cloud::CloudControlsPartner::V1::Violation

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

    Parameters:

    • request (::Google::Cloud::CloudControlsPartner::V1::GetViolationRequest, ::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_violation(name: nil) ⇒ ::Google::Cloud::CloudControlsPartner::V1::Violation

    Pass arguments to get_violation 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. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/violations/{violation}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
367
368
369
370
371
372
373
374
 
# File 'lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_monitoring/client.rb', line 334

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudControlsPartner::V1::GetViolationRequest

  # 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_violation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::CloudControlsPartner::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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_violation.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_violation.retry_policy

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

  @cloud_controls_partner_monitoring_stub.call_rpc :get_violation, 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_violations(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CloudControlsPartner::V1::Violation> #list_violations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, interval: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CloudControlsPartner::V1::Violation>

Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of {customer} & {workload}. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

Examples:

Basic example

require "google/cloud/cloud_controls_partner/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CloudControlsPartner::V1::CloudControlsPartnerMonitoring::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CloudControlsPartner::V1::ListViolationsRequest.new

# Call the list_violations method.
result = client.list_violations request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::CloudControlsPartner::V1::Violation.
  p item
end

Overloads:

  • #list_violations(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CloudControlsPartner::V1::Violation>

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

    Parameters:

    • request (::Google::Cloud::CloudControlsPartner::V1::ListViolationsRequest, ::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_violations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, interval: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CloudControlsPartner::V1::Violation>

    Pass arguments to list_violations 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. Parent resource Format organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

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

      Optional. The maximum number of customers row to return. The service may return fewer than this value. If unspecified, at most 10 customers will be returned.

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

      Optional. A page token, received from a previous ListViolations call. Provide this to retrieve the subsequent page.

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

      Optional. Filtering results

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

      Optional. Hint for how to order the results

    • interval (::Google::Type::Interval, ::Hash) (defaults to: nil) —

      Optional. Specifies the interval for retrieving violations. if unspecified, all violations will be returned.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



246
247
248
249
250
251
252
253
254
255
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
 
# File 'lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_monitoring/client.rb', line 246

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudControlsPartner::V1::ListViolationsRequest

  # 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_violations.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::CloudControlsPartner::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  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_violations.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_violations.retry_policy

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

  @cloud_controls_partner_monitoring_stub.call_rpc :list_violations, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @cloud_controls_partner_monitoring_stub, :list_violations, 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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


114
115
116
 
# File 'lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_monitoring/client.rb', line 114

def universe_domain
  @cloud_controls_partner_monitoring_stub.universe_domain
end