google-cloud-memcache-v1beta2 0.1.2 → 0.2.3

data/proto_docs/google/cloud/memcache/v1beta2/cloud_memcache.rb

@@ -21,34 +21,35 @@ module Google
   module Cloud
     module Memcache
       module V1beta2
+        # A Memorystore for Memcached instance
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. Unique name of the resource in this scope including project and
         #     location using the form:
         #         `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
         #
-        #     Note: Memcached instances are managed and addressed at regional level so
-        #     location_id here refers to a GCP region; however, users may choose which
-        #     zones Memcached nodes within an instances should be provisioned in.
-        #     Refer to [zones] field for more details.
+        #     Note: Memcached instances are managed and addressed at the regional level
+        #     so `location_id` here refers to a Google Cloud region; however, users may
+        #     choose which zones Memcached nodes should be provisioned in within an
+        #     instance. Refer to {::Google::Cloud::Memcache::V1beta2::Instance#zones zones} field for more details.
         # @!attribute [rw] display_name
         #   @return [::String]
-        #     Optional. User provided name for the instance only used for display
+        #     User provided name for the instance, which is only used for display
         #     purposes. Cannot be more than 80 characters.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
-        #     Optional. Resource labels to represent user-provided metadata.
+        #     Resource labels to represent user-provided metadata.
         #     Refer to cloud documentation on labels for more details.
         #     https://cloud.google.com/compute/docs/labeling-resources
         # @!attribute [rw] authorized_network
         #   @return [::String]
-        #     Optional. The full name of the Google Compute Engine
+        #     The full name of the Google Compute Engine
         #     [network](https://cloud.google.com/vpc/docs/vpc) to which the
         #     instance is connected. If left unspecified, the `default` network
         #     will be used.
         # @!attribute [rw] zones
         #   @return [::Array<::String>]
-        #     Optional. Zones where Memcached nodes should be provisioned in.
+        #     Zones in which Memcached nodes should be provisioned.
         #     Memcached nodes will be equally distributed across these zones. If not
         #     provided, the service will by default create nodes in all zones in the
         #     region for the instance.
@@ -60,9 +61,9 @@ module Google
         #     Required. Configuration for Memcached nodes.
         # @!attribute [rw] memcache_version
         #   @return [::Google::Cloud::Memcache::V1beta2::MemcacheVersion]
-        #     Optional. The major version of Memcached software.
+        #     The major version of Memcached software.
         #     If not provided, latest supported version will be used. Currently the
-        #     latest supported major version is MEMCACHE_1_5.
+        #     latest supported major version is `MEMCACHE_1_5`.
         #     The minor version will be automatically determined by our system based on
         #     the latest supported minor version.
         # @!attribute [rw] parameters
@@ -72,7 +73,7 @@ module Google
         # @!attribute [r] memcache_nodes
         #   @return [::Array<::Google::Cloud::Memcache::V1beta2::Instance::Node>]
         #     Output only. List of Memcached nodes.
-        #     Refer to [Node] message for more details.
+        #     Refer to {::Google::Cloud::Memcache::V1beta2::Instance::Node Node} message for more details.
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The time the instance was created.
@@ -90,10 +91,13 @@ module Google
         #     The full version format will be "memcached-1.5.16".
         # @!attribute [rw] instance_messages
         #   @return [::Array<::Google::Cloud::Memcache::V1beta2::Instance::InstanceMessage>]
-        #     List of messages that describe current statuses of memcached instance.
+        #     List of messages that describe the current state of the Memcached instance.
         # @!attribute [r] discovery_endpoint
         #   @return [::String]
-        #     Output only. Endpoint for Discovery API
+        #     Output only. Endpoint for the Discovery API.
+        # @!attribute [r] update_available
+        #   @return [::Boolean]
+        #     Output only. Returns true if there is an update waiting to be applied
         class Instance
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -130,12 +134,14 @@ module Google
           # @!attribute [rw] parameters
           #   @return [::Google::Cloud::Memcache::V1beta2::MemcacheParameters]
           #     User defined parameters currently applied to the node.
+          # @!attribute [r] update_available
+          #   @return [::Boolean]
+          #     Output only. Returns true if there is an update waiting to be applied
           class Node
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
 
             # Different states of a Memcached node.
-            # LINT.IfChange
             module State
               # Node state is not set.
               STATE_UNSPECIFIED = 0
@@ -183,7 +189,6 @@ module Google
           end
 
           # Different states of a Memcached instance.
-          # LINT.IfChange
           module State
             # State not set.
             STATE_UNSPECIFIED = 0
@@ -213,18 +218,17 @@ module Google
         #     The maximum number of items to return.
         #
         #     If not specified, a default value of 1000 will be used by the service.
-        #     Regardless of the page_size value, the response may include a partial list
-        #     and a caller should only rely on response's
-        #     [next_page_token][CloudMemcache.ListInstancesResponse.next_page_token]
+        #     Regardless of the `page_size` value, the response may include a partial
+        #     list and a caller should only rely on response's
+        #     {::Google::Cloud::Memcache::V1beta2::ListInstancesResponse#next_page_token `next_page_token`}
         #     to determine if there are more instances left to be queried.
         # @!attribute [rw] page_token
         #   @return [::String]
-        #     The next_page_token value returned from a previous List request,
-        #     if any.
+        #     The `next_page_token` value returned from a previous List request, if any.
         # @!attribute [rw] filter
         #   @return [::String]
         #     List filter. For example, exclude all Memcached instances with name as
-        #     my-instance by specifying "name != my-instance".
+        #     my-instance by specifying `"name != my-instance"`.
         # @!attribute [rw] order_by
         #   @return [::String]
         #     Sort results. Supported values are "name", "name desc" or "" (unsorted).
@@ -279,7 +283,9 @@ module Google
         #     * Must start with a letter.
         #     * Must be between 1-40 characters.
         #     * Must end with a number or a letter.
-        #     * Must be unique within the user project / location
+        #     * Must be unique within the user project / location.
+        #
+        #     If any of the above are not met, the API raises an invalid argument error.
         # @!attribute [rw] resource
         #   @return [::Google::Cloud::Memcache::V1beta2::Instance]
         #     Required. A Memcached [Instance] resource
@@ -292,7 +298,7 @@ module Google
         # @!attribute [rw] update_mask
         #   @return [::Google::Protobuf::FieldMask]
         #     Required. Mask of fields to update.
-        #      *   `displayName`
+        #      *  `displayName`
         # @!attribute [rw] resource
         #   @return [::Google::Cloud::Memcache::V1beta2::Instance]
         #     Required. A Memcached [Instance] resource.
@@ -305,7 +311,7 @@ module Google
         # Request for {::Google::Cloud::Memcache::V1beta2::CloudMemcache::Client#delete_instance DeleteInstance}.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Memcached instance resource name in the format:
+        #     Required. Memcached instance resource name in the format:
         #         `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
         #     where `location_id` refers to a GCP region
         class DeleteInstanceRequest
@@ -320,12 +326,12 @@ module Google
         #     should be applied.
         # @!attribute [rw] node_ids
         #   @return [::Array<::String>]
-        #     Nodes to which we should apply the instance-level parameter group.
+        #     Nodes to which the instance-level parameter group is applied.
         # @!attribute [rw] apply_all
         #   @return [::Boolean]
         #     Whether to apply instance-level parameter group to all nodes. If set to
-        #     true, will explicitly restrict users from specifying any nodes, and apply
-        #     parameter group updates to all nodes within the instance.
+        #     true, users are restricted from specifying individual nodes, and
+        #     `ApplyParameters` updates all nodes within the instance.
         class ApplyParametersRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -347,12 +353,33 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request for {::Google::Cloud::Memcache::V1beta2::CloudMemcache::Client#apply_software_update ApplySoftwareUpdate}.
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     Required. Resource name of the Memcached instance for which software update should be
+        #     applied.
+        # @!attribute [rw] node_ids
+        #   @return [::Array<::String>]
+        #     Nodes to which we should apply the update to. Note all the selected nodes
+        #     are updated in parallel.
+        # @!attribute [rw] apply_all
+        #   @return [::Boolean]
+        #     Whether to apply the update to all nodes. If set to
+        #     true, will explicitly restrict users from specifying any nodes, and apply
+        #     software update to all nodes (where applicable) within the instance.
+        class ApplySoftwareUpdateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The unique ID associated with this set of parameters. Users
+        # can use this id to determine if the parameters associated with the instance
+        # differ from the parameters associated with the nodes. A discrepancy between
+        # parameter ids can inform users that they may need to take action to apply
+        # parameters on nodes.
         # @!attribute [r] id
         #   @return [::String]
-        #     Output only. The unique ID associated with this set of parameters. Users
-        #     can use this id to determine if the parameters associated with the instance
-        #     differ from the parameters associated with the nodes and any action needs
-        #     to be taken to apply parameters on nodes.
+        #     Output only.
         # @!attribute [rw] params
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     User defined set of parameters to use in the memcached process.
@@ -371,30 +398,30 @@ module Google
         end
 
         # Represents the metadata of a long-running operation.
-        # @!attribute [rw] create_time
+        # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Time when the operation was created.
-        # @!attribute [rw] end_time
+        #     Output only. Time when the operation was created.
+        # @!attribute [r] end_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Time when the operation finished running.
-        # @!attribute [rw] target
+        #     Output only. Time when the operation finished running.
+        # @!attribute [r] target
         #   @return [::String]
-        #     Server-defined resource path for the target of the operation.
-        # @!attribute [rw] verb
+        #     Output only. Server-defined resource path for the target of the operation.
+        # @!attribute [r] verb
         #   @return [::String]
-        #     Name of the verb executed by the operation.
-        # @!attribute [rw] status_detail
+        #     Output only. Name of the verb executed by the operation.
+        # @!attribute [r] status_detail
         #   @return [::String]
-        #     Human-readable status of the operation, if any.
-        # @!attribute [rw] cancel_requested
+        #     Output only. Human-readable status of the operation, if any.
+        # @!attribute [r] cancel_requested
         #   @return [::Boolean]
-        #     Identifies whether the user has requested cancellation
+        #     Output only. Identifies whether the user has requested cancellation
         #     of the operation. Operations that have successfully been cancelled
         #     have [Operation.error][] value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
         #     corresponding to `Code.CANCELLED`.
-        # @!attribute [rw] api_version
+        # @!attribute [r] api_version
         #   @return [::String]
-        #     API version used to start the operation.
+        #     Output only. API version used to start the operation.
         class OperationMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/longrunning/operations.rb

@@ -25,7 +25,7 @@ module Google
     #   @return [::String]
     #     The server-assigned name, which is only unique within the same service that
     #     originally returns it. If you use the default HTTP mapping, the
-    #     `name` should have the format of `operations/some/unique/name`.
+    #     `name` should be a resource name ending with `operations/{unique_id}`.
     # @!attribute [rw] metadata
     #   @return [::Google::Protobuf::Any]
     #     Service-specific metadata associated with the operation.  It typically
@@ -35,7 +35,7 @@ module Google
     # @!attribute [rw] done
     #   @return [::Boolean]
     #     If the value is `false`, it means the operation is still in progress.
-    #     If true, the operation is completed, and either `error` or `response` is
+    #     If `true`, the operation is completed, and either `error` or `response` is
     #     available.
     # @!attribute [rw] error
     #   @return [::Google::Rpc::Status]
@@ -67,7 +67,7 @@ module Google
     # The request message for Operations.ListOperations.
     # @!attribute [rw] name
     #   @return [::String]
-    #     The name of the operation collection.
+    #     The name of the operation's parent resource.
     # @!attribute [rw] filter
     #   @return [::String]
     #     The standard list filter.
@@ -112,6 +112,20 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
+    # The request message for Operations.WaitOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to wait on.
+    # @!attribute [rw] timeout
+    #   @return [::Google::Protobuf::Duration]
+    #     The maximum duration to wait before timing out. If left blank, the wait
+    #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+    #     If RPC context deadline is also specified, the shorter one will be used.
+    class WaitOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
     # A message representing the message types used by a long-running operation.
     #
     # Example:

data/proto_docs/google/protobuf/any.rb

@@ -57,10 +57,13 @@ module Google
     #  Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
-    #      any, err := ptypes.MarshalAny(foo)
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
     #      ...
     #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #      if err := any.UnmarshalTo(foo); err != nil {
     #        ...
     #      }
     #

data/proto_docs/google/protobuf/duration.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Protobuf
+    # A Duration represents a signed, fixed-length span of time represented
+    # as a count of seconds and fractions of seconds at nanosecond
+    # resolution. It is independent of any calendar and concepts like "day"
+    # or "month". It is related to Timestamp in that the difference between
+    # two Timestamp values is a Duration and it can be added or subtracted
+    # from a Timestamp. Range is approximately +-10,000 years.
+    #
+    # # Examples
+    #
+    # Example 1: Compute Duration from two Timestamps in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Timestamp end = ...;
+    #     Duration duration = ...;
+    #
+    #     duration.seconds = end.seconds - start.seconds;
+    #     duration.nanos = end.nanos - start.nanos;
+    #
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
+    #       duration.seconds += 1;
+    #       duration.nanos -= 1000000000;
+    #     } else if (duration.seconds > 0 && duration.nanos < 0) {
+    #       duration.seconds -= 1;
+    #       duration.nanos += 1000000000;
+    #     }
+    #
+    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Duration duration = ...;
+    #     Timestamp end = ...;
+    #
+    #     end.seconds = start.seconds + duration.seconds;
+    #     end.nanos = start.nanos + duration.nanos;
+    #
+    #     if (end.nanos < 0) {
+    #       end.seconds -= 1;
+    #       end.nanos += 1000000000;
+    #     } else if (end.nanos >= 1000000000) {
+    #       end.seconds += 1;
+    #       end.nanos -= 1000000000;
+    #     }
+    #
+    # Example 3: Compute Duration from datetime.timedelta in Python.
+    #
+    #     td = datetime.timedelta(days=3, minutes=10)
+    #     duration = Duration()
+    #     duration.FromTimedelta(td)
+    #
+    # # JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Signed seconds of the span of time. Must be from -315,576,000,000
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Signed fractions of a second at nanosecond resolution of the span
+    #     of time. Durations less than one second are represented with a 0
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
+    #     to +999,999,999 inclusive.
+    class Duration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/protobuf/timestamp.rb

@@ -70,7 +70,16 @@ module Google
     #         .setNanos((int) ((millis % 1000) * 1000000)).build();
     #
     #
-    # Example 5: Compute Timestamp from current time in Python.
+    # Example 5: Compute Timestamp from Java `Instant.now()`.
+    #
+    #     Instant now = Instant.now();
+    #
+    #     Timestamp timestamp =
+    #         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+    #             .setNanos(now.getNano()).build();
+    #
+    #
+    # Example 6: Compute Timestamp from current time in Python.
     #
     #     timestamp = Timestamp()
     #     timestamp.GetCurrentTime()

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-memcache-v1beta2
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +157,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Google Cloud Memorystore for Memcached API is used for creating and managing
-  Memcached instances in GCP.
+  Memcached instances in GCP. Note that google-cloud-memcache-v1beta2 is a version-specific
+  client library. For most uses, we recommend installing the main client library google-cloud-memcache
+  instead. See the readme for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -177,6 +185,7 @@ files:
 - proto_docs/google/cloud/memcache/v1beta2/cloud_memcache.rb
 - proto_docs/google/longrunning/operations.rb
 - proto_docs/google/protobuf/any.rb
+- proto_docs/google/protobuf/duration.rb
 - proto_docs/google/protobuf/empty.rb
 - proto_docs/google/protobuf/field_mask.rb
 - proto_docs/google/protobuf/timestamp.rb
@@ -193,14 +202,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for the Google Cloud Memorystore for Memcached API