google-cloud-monitoring 0.28.0 → 0.29.0

data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb

@@ -15,6 +15,26 @@
 module Google
   module Monitoring
     module V3
+      # Nimbus InternalCheckers.
+      # @!attribute [rw] project_id
+      #   @return [String]
+      #     The GCP project ID. Not necessarily the same as the project_id for the
+      #     config.
+      # @!attribute [rw] network
+      #   @return [String]
+      #     The internal network to perform this uptime check on.
+      # @!attribute [rw] gcp_zone
+      #   @return [String]
+      #     The GCP zone the uptime check should egress from. Only respected for
+      #     internal uptime checks, where internal_network is specified.
+      # @!attribute [rw] checker_id
+      #   @return [String]
+      #     The checker ID.
+      # @!attribute [rw] display_name
+      #   @return [String]
+      #     The checker's human-readable name.
+      class InternalChecker; end
+
       # This message configures which resources and services to monitor for
       # availability.
       # @!attribute [rw] name
@@ -34,7 +54,15 @@ module Google
       #     to identify; however, uniqueness is not enforced. Required.
       # @!attribute [rw] monitored_resource
       #   @return [Google::Api::MonitoredResource]
-      #     The monitored resource associated with the configuration.
+      #     The [monitored
+      #     resource](https://cloud.google.com/monitoring/api/resources) associated
+      #     with the configuration.
+      #     The following monitored resource types are supported for uptime checks:
+      #       uptime_url
+      #       gce_instance
+      #       gae_app
+      #       aws_ec2_instance
+      #       aws_elb_load_balancer
       # @!attribute [rw] resource_group
       #   @return [Google::Monitoring::V3::UptimeCheckConfig::ResourceGroup]
       #     The group resource associated with the configuration.
@@ -46,8 +74,10 @@ module Google
       #     Contains information needed to make a TCP check.
       # @!attribute [rw] period
       #   @return [Google::Protobuf::Duration]
-      #     How often the uptime check is performed.
-      #     Currently, only 1, 5, 10, and 15 minutes are supported. Required.
+      #     How often, in seconds, the uptime check is performed.
+      #     Currently, the only supported values are +60s+ (1 minute), +300s+
+      #     (5 minutes), +600s+ (10 minutes), and +900s+ (15 minutes). Optional,
+      #     defaults to +300s+.
       # @!attribute [rw] timeout
       #   @return [Google::Protobuf::Duration]
       #     The maximum amount of time to wait for the request to complete (must be
@@ -66,9 +96,14 @@ module Google
       #     3 locations must be provided, or an error message is returned.
       #     Not specifying this field will result in uptime checks running from all
       #     regions.
+      # @!attribute [rw] is_internal
+      #   @return [true, false]
+      #     Denotes whether this is a check that egresses from InternalCheckers.
       # @!attribute [rw] internal_checkers
-      #   @return [Array<Google::Monitoring::V3::UptimeCheckConfig::InternalChecker>]
-      #     The internal checkers that this check will egress from.
+      #   @return [Array<Google::Monitoring::V3::InternalChecker>]
+      #     The internal checkers that this check will egress from. If +is_internal+ is
+      #     true and this list is empty, the check will egress from all
+      #     InternalCheckers configured for the project that owns this CheckConfig.
       class UptimeCheckConfig
         # The resource submessage for group checks. It can be used instead of a
         # monitored resource, when multiple resources are being monitored.
@@ -116,6 +151,7 @@ module Google
         #     https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31).
         #     Entering two separate headers with the same key in a Create call will
         #     cause the first to be overwritten by the second.
+        #     The maximum number of headers allowed is 100.
         class HttpCheck
           # A type of authentication to perform against the specified resource or URL
           # that uses username and password.
@@ -142,27 +178,8 @@ module Google
         # and more complex matching.
         # @!attribute [rw] content
         #   @return [String]
-        #     String content to match
+        #     String content to match (max 1024 bytes)
         class ContentMatcher; end
-
-        # Nimbus InternalCheckers.
-        # @!attribute [rw] project_id
-        #   @return [String]
-        #     The GCP project ID. Not necessarily the same as the project_id for the config.
-        # @!attribute [rw] network
-        #   @return [String]
-        #     The internal network to perform this uptime check on.
-        # @!attribute [rw] gcp_zone
-        #   @return [String]
-        #     The GCP zone the uptime check should egress from. Only respected for
-        #     internal uptime checks, where internal_network is specified.
-        # @!attribute [rw] checker_id
-        #   @return [String]
-        #     The checker ID.
-        # @!attribute [rw] display_name
-        #   @return [String]
-        #     The checker's human-readable name.
-        class InternalChecker; end
       end
 
       # Contains the region, location, and list of IP
@@ -206,16 +223,19 @@ module Google
       end
 
       # The supported resource types that can be used as values of
-      # group_resource.resource_type. gae_app and uptime_url are not allowed
-      # because group checks on App Engine modules and URLs are not allowed.
+      # +group_resource.resource_type+.
+      # +INSTANCE+ includes +gce_instance+ and +aws_ec2_instance+ resource types.
+      # The resource types +gae_app+ and +uptime_url+ are not valid here because
+      # group checks on App Engine modules and URLs are not allowed.
       module GroupResourceType
         # Default value (not valid).
         RESOURCE_TYPE_UNSPECIFIED = 0
 
-        # A group of instances (could be either GCE or AWS_EC2).
+        # A group of instances from Google Cloud Platform (GCP) or
+        # Amazon Web Services (AWS).
         INSTANCE = 1
 
-        # A group of AWS load balancers.
+        # A group of Amazon ELB load balancers.
         AWS_ELB_LOAD_BALANCER = 2
       end
     end

data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime_service.rb

@@ -0,0 +1,131 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Monitoring
+    module V3
+      # The protocol for the +ListUptimeCheckConfigs+ request.
+      # @!attribute [rw] parent
+      #   @return [String]
+      #     The project whose uptime check configurations are listed. The format
+      #       is +projects/[PROJECT_ID]+.
+      # @!attribute [rw] page_size
+      #   @return [Integer]
+      #     The maximum number of results to return in a single response. The server
+      #     may further constrain the maximum number of results returned in a single
+      #     page. If the page_size is <=0, the server will decide the number of results
+      #     to be returned.
+      # @!attribute [rw] page_token
+      #   @return [String]
+      #     If this field is not empty then it must contain the +nextPageToken+ value
+      #     returned by a previous call to this method.  Using this field causes the
+      #     method to return more results from the previous method call.
+      class ListUptimeCheckConfigsRequest; end
+
+      # The protocol for the +ListUptimeCheckConfigs+ response.
+      # @!attribute [rw] uptime_check_configs
+      #   @return [Array<Google::Monitoring::V3::UptimeCheckConfig>]
+      #     The returned uptime check configurations.
+      # @!attribute [rw] next_page_token
+      #   @return [String]
+      #     This field represents the pagination token to retrieve the next page of
+      #     results. If the value is empty, it means no further results for the
+      #     request. To retrieve the next page of results, the value of the
+      #     next_page_token is passed to the subsequent List method call (in the
+      #     request message's page_token field).
+      # @!attribute [rw] total_size
+      #   @return [Integer]
+      #     The total number of uptime check configurations for the project,
+      #     irrespective of any pagination.
+      class ListUptimeCheckConfigsResponse; end
+
+      # The protocol for the +GetUptimeCheckConfig+ request.
+      # @!attribute [rw] name
+      #   @return [String]
+      #     The uptime check configuration to retrieve. The format
+      #       is +projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]+.
+      class GetUptimeCheckConfigRequest; end
+
+      # The protocol for the +CreateUptimeCheckConfig+ request.
+      # @!attribute [rw] parent
+      #   @return [String]
+      #     The project in which to create the uptime check. The format
+      #       is +projects/[PROJECT_ID]+.
+      # @!attribute [rw] uptime_check_config
+      #   @return [Google::Monitoring::V3::UptimeCheckConfig]
+      #     The new uptime check configuration.
+      class CreateUptimeCheckConfigRequest; end
+
+      # The protocol for the +UpdateUptimeCheckConfig+ request.
+      # @!attribute [rw] update_mask
+      #   @return [Google::Protobuf::FieldMask]
+      #     Optional. If present, only the listed fields in the current uptime check
+      #     configuration are updated with values from the new configuration. If this
+      #     field is empty, then the current configuration is completely replaced with
+      #     the new configuration.
+      # @!attribute [rw] uptime_check_config
+      #   @return [Google::Monitoring::V3::UptimeCheckConfig]
+      #     Required. If an +"updateMask"+ has been specified, this field gives
+      #     the values for the set of fields mentioned in the +"updateMask"+. If an
+      #     +"updateMask"+ has not been given, this uptime check configuration replaces
+      #     the current configuration. If a field is mentioned in +"updateMask"+ but
+      #     the corresonding field is omitted in this partial uptime check
+      #     configuration, it has the effect of deleting/clearing the field from the
+      #     configuration on the server.
+      #
+      #     The following fields can be updated: +display_name+,
+      #     +http_check+, +tcp_check+, +timeout+, +content_matchers+, and
+      #     +selected_regions+.
+      class UpdateUptimeCheckConfigRequest; end
+
+      # The protocol for the +DeleteUptimeCheckConfig+ request.
+      # @!attribute [rw] name
+      #   @return [String]
+      #     The uptime check configuration to delete. The format
+      #       is +projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]+.
+      class DeleteUptimeCheckConfigRequest; end
+
+      # The protocol for the +ListUptimeCheckIps+ request.
+      # @!attribute [rw] page_size
+      #   @return [Integer]
+      #     The maximum number of results to return in a single response. The server
+      #     may further constrain the maximum number of results returned in a single
+      #     page. If the page_size is <=0, the server will decide the number of results
+      #     to be returned.
+      #     NOTE: this field is not yet implemented
+      # @!attribute [rw] page_token
+      #   @return [String]
+      #     If this field is not empty then it must contain the +nextPageToken+ value
+      #     returned by a previous call to this method.  Using this field causes the
+      #     method to return more results from the previous method call.
+      #     NOTE: this field is not yet implemented
+      class ListUptimeCheckIpsRequest; end
+
+      # The protocol for the +ListUptimeCheckIps+ response.
+      # @!attribute [rw] uptime_check_ips
+      #   @return [Array<Google::Monitoring::V3::UptimeCheckIp>]
+      #     The returned list of IP addresses (including region and location) that the
+      #     checkers run from.
+      # @!attribute [rw] next_page_token
+      #   @return [String]
+      #     This field represents the pagination token to retrieve the next page of
+      #     results. If the value is empty, it means no further results for the
+      #     request. To retrieve the next page of results, the value of the
+      #     next_page_token is passed to the subsequent List method call (in the
+      #     request message's page_token field).
+      #     NOTE: this field is not yet implemented
+      class ListUptimeCheckIpsResponse; end
+    end
+  end
+end

data/lib/google/cloud/monitoring/v3/doc/google/protobuf/any.rb

@@ -0,0 +1,124 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Protobuf
+    # +Any+ contains an arbitrary serialized protocol buffer message along with a
+    # URL that describes the type of the serialized message.
+    #
+    # Protobuf library provides support to pack/unpack Any values in the form
+    # of utility functions or additional generated methods of the Any type.
+    #
+    # Example 1: Pack and unpack a message in C++.
+    #
+    #     Foo foo = ...;
+    #     Any any;
+    #     any.PackFrom(foo);
+    #     ...
+    #     if (any.UnpackTo(&foo)) {
+    #       ...
+    #     }
+    #
+    # Example 2: Pack and unpack a message in Java.
+    #
+    #     Foo foo = ...;
+    #     Any any = Any.pack(foo);
+    #     ...
+    #     if (any.is(Foo.class)) {
+    #       foo = any.unpack(Foo.class);
+    #     }
+    #
+    #  Example 3: Pack and unpack a message in Python.
+    #
+    #     foo = Foo(...)
+    #     any = Any()
+    #     any.Pack(foo)
+    #     ...
+    #     if any.Is(Foo.DESCRIPTOR):
+    #       any.Unpack(foo)
+    #       ...
+    #
+    #  Example 4: Pack and unpack a message in Go
+    #
+    #      foo := &pb.Foo{...}
+    #      any, err := ptypes.MarshalAny(foo)
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #        ...
+    #      }
+    #
+    # The pack methods provided by protobuf library will by default use
+    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
+    # methods only use the fully qualified type name after the last '/'
+    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
+    # name "y.z".
+    #
+    #
+    # = JSON
+    #
+    # The JSON representation of an +Any+ value uses the regular
+    # representation of the deserialized, embedded message, with an
+    # additional field +@type+ which contains the type URL. Example:
+    #
+    #     package google.profile;
+    #     message Person {
+    #       string first_name = 1;
+    #       string last_name = 2;
+    #     }
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.profile.Person",
+    #       "firstName": <string>,
+    #       "lastName": <string>
+    #     }
+    #
+    # If the embedded message type is well-known and has a custom JSON
+    # representation, that representation will be embedded adding a field
+    # +value+ which holds the custom JSON in addition to the +@type+
+    # field. Example (for message {Google::Protobuf::Duration}):
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.protobuf.Duration",
+    #       "value": "1.212s"
+    #     }
+    # @!attribute [rw] type_url
+    #   @return [String]
+    #     A URL/resource name whose content describes the type of the
+    #     serialized protocol buffer message.
+    #
+    #     For URLs which use the scheme +http+, +https+, or no scheme, the
+    #     following restrictions and interpretations apply:
+    #
+    #     * If no scheme is provided, +https+ is assumed.
+    #     * The last segment of the URL's path must represent the fully
+    #       qualified name of the type (as in +path/google.protobuf.Duration+).
+    #       The name should be in a canonical form (e.g., leading "." is
+    #       not accepted).
+    #     * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
+    #       value in binary format, or produce an error.
+    #     * Applications are allowed to cache lookup results based on the
+    #       URL, or have them precompiled into a binary to avoid any
+    #       lookup. Therefore, binary compatibility needs to be preserved
+    #       on changes to types. (Use versioned type names to manage
+    #       breaking changes.)
+    #
+    #     Schemes other than +http+, +https+ (or the empty scheme) might be
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any; end
+  end
+end

data/lib/google/cloud/monitoring/v3/doc/google/protobuf/empty.rb

@@ -0,0 +1,28 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Protobuf
+    # A generic empty message that you can re-use to avoid defining duplicated
+    # empty messages in your APIs. A typical example is to use it as the request
+    # or the response type of an API method. For instance:
+    #
+    #     service Foo {
+    #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+    #     }
+    #
+    # The JSON representation for +Empty+ is empty JSON object +{}+.
+    class Empty; end
+  end
+end

data/lib/google/cloud/monitoring/v3/doc/google/protobuf/struct.rb

@@ -0,0 +1,73 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Protobuf
+    # +Struct+ represents a structured data value, consisting of fields
+    # which map to dynamically typed values. In some languages, +Struct+
+    # might be supported by a native representation. For example, in
+    # scripting languages like JS a struct is represented as an
+    # object. The details of that representation are described together
+    # with the proto support for the language.
+    #
+    # The JSON representation for +Struct+ is JSON object.
+    # @!attribute [rw] fields
+    #   @return [Hash{String => Google::Protobuf::Value}]
+    #     Unordered map of dynamically typed values.
+    class Struct; end
+
+    # +Value+ represents a dynamically typed value which can be either
+    # null, a number, a string, a boolean, a recursive struct value, or a
+    # list of values. A producer of value is expected to set one of that
+    # variants, absence of any variant indicates an error.
+    #
+    # The JSON representation for +Value+ is JSON value.
+    # @!attribute [rw] null_value
+    #   @return [Google::Protobuf::NullValue]
+    #     Represents a null value.
+    # @!attribute [rw] number_value
+    #   @return [Float]
+    #     Represents a double value.
+    # @!attribute [rw] string_value
+    #   @return [String]
+    #     Represents a string value.
+    # @!attribute [rw] bool_value
+    #   @return [true, false]
+    #     Represents a boolean value.
+    # @!attribute [rw] struct_value
+    #   @return [Google::Protobuf::Struct]
+    #     Represents a structured value.
+    # @!attribute [rw] list_value
+    #   @return [Google::Protobuf::ListValue]
+    #     Represents a repeated +Value+.
+    class Value; end
+
+    # +ListValue+ is a wrapper around a repeated field of values.
+    #
+    # The JSON representation for +ListValue+ is JSON array.
+    # @!attribute [rw] values
+    #   @return [Array<Google::Protobuf::Value>]
+    #     Repeated field of dynamically typed values.
+    class ListValue; end
+
+    # +NullValue+ is a singleton enumeration to represent the null value for the
+    # +Value+ type union.
+    #
+    #  The JSON representation for +NullValue+ is JSON +null+.
+    module NullValue
+      # Null value.
+      NULL_VALUE = 0
+    end
+  end
+end