google-cloud-memcache-v1beta2 0.1.2 → 0.2.0

data/lib/google/cloud/memcache/v1beta2/cloud_memcache_pb.rb

@@ -29,6 +29,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :memcache_full_version, :string, 18
       repeated :instance_messages, :message, 19, "google.cloud.memcache.v1beta2.Instance.InstanceMessage"
       optional :discovery_endpoint, :string, 20
+      optional :update_available, :bool, 21
     end
     add_message "google.cloud.memcache.v1beta2.Instance.NodeConfig" do
       optional :cpu_count, :int32, 1
@@ -41,6 +42,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :host, :string, 4
       optional :port, :int32, 5
       optional :parameters, :message, 6, "google.cloud.memcache.v1beta2.MemcacheParameters"
+      optional :update_available, :bool, 7
     end
     add_enum "google.cloud.memcache.v1beta2.Instance.Node.State" do
       value :STATE_UNSPECIFIED, 0
@@ -101,6 +103,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :update_mask, :message, 2, "google.protobuf.FieldMask"
       optional :parameters, :message, 3, "google.cloud.memcache.v1beta2.MemcacheParameters"
     end
+    add_message "google.cloud.memcache.v1beta2.ApplySoftwareUpdateRequest" do
+      optional :instance, :string, 1
+      repeated :node_ids, :string, 2
+      optional :apply_all, :bool, 3
+    end
     add_message "google.cloud.memcache.v1beta2.MemcacheParameters" do
       optional :id, :string, 1
       map :params, :string, :string, 3
@@ -145,6 +152,7 @@ module Google
         DeleteInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1beta2.DeleteInstanceRequest").msgclass
         ApplyParametersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1beta2.ApplyParametersRequest").msgclass
         UpdateParametersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1beta2.UpdateParametersRequest").msgclass
+        ApplySoftwareUpdateRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1beta2.ApplySoftwareUpdateRequest").msgclass
         MemcacheParameters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1beta2.MemcacheParameters").msgclass
         OperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1beta2.OperationMetadata").msgclass
         LocationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1beta2.LocationMetadata").msgclass

data/lib/google/cloud/memcache/v1beta2/cloud_memcache_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/cloud/memcache/v1beta2/cloud_memcache.proto for package 'google.cloud.memcache.v1beta2'
 # Original file comments:
-# Copyright 2019 Google LLC.
+# 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.
@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-#
 
 require 'grpc'
 require 'google/cloud/memcache/v1beta2/cloud_memcache_pb'
@@ -38,7 +37,7 @@ module Google
           # * As such, Memcached instances are resources of the form:
           #   `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
           #
-          # Note that location_id must be refering to a GCP `region`; for example:
+          # Note that location_id must be a GCP `region`; for example:
           # * `projects/my-memcached-project/locations/us-central1/instances/my-memcached`
           class Service
 
@@ -48,23 +47,26 @@ module Google
             self.unmarshal_class_method = :decode
             self.service_name = 'google.cloud.memcache.v1beta2.CloudMemcache'
 
-            # Lists Instances in a given project and location.
-            rpc :ListInstances, Google::Cloud::Memcache::V1beta2::ListInstancesRequest, Google::Cloud::Memcache::V1beta2::ListInstancesResponse
+            # Lists Instances in a given location.
+            rpc :ListInstances, ::Google::Cloud::Memcache::V1beta2::ListInstancesRequest, ::Google::Cloud::Memcache::V1beta2::ListInstancesResponse
             # Gets details of a single Instance.
-            rpc :GetInstance, Google::Cloud::Memcache::V1beta2::GetInstanceRequest, Google::Cloud::Memcache::V1beta2::Instance
-            # Creates a new Instance in a given project and location.
-            rpc :CreateInstance, Google::Cloud::Memcache::V1beta2::CreateInstanceRequest, Google::Longrunning::Operation
+            rpc :GetInstance, ::Google::Cloud::Memcache::V1beta2::GetInstanceRequest, ::Google::Cloud::Memcache::V1beta2::Instance
+            # Creates a new Instance in a given location.
+            rpc :CreateInstance, ::Google::Cloud::Memcache::V1beta2::CreateInstanceRequest, ::Google::Longrunning::Operation
             # Updates an existing Instance in a given project and location.
-            rpc :UpdateInstance, Google::Cloud::Memcache::V1beta2::UpdateInstanceRequest, Google::Longrunning::Operation
-            # Updates the defined Memcached Parameters for an existing Instance.
+            rpc :UpdateInstance, ::Google::Cloud::Memcache::V1beta2::UpdateInstanceRequest, ::Google::Longrunning::Operation
+            # Updates the defined Memcached parameters for an existing instance.
             # This method only stages the parameters, it must be followed by
-            # ApplyParameters to apply the parameters to nodes of the Memcached Instance.
-            rpc :UpdateParameters, Google::Cloud::Memcache::V1beta2::UpdateParametersRequest, Google::Longrunning::Operation
+            # `ApplyParameters` to apply the parameters to nodes of the Memcached
+            # instance.
+            rpc :UpdateParameters, ::Google::Cloud::Memcache::V1beta2::UpdateParametersRequest, ::Google::Longrunning::Operation
             # Deletes a single Instance.
-            rpc :DeleteInstance, Google::Cloud::Memcache::V1beta2::DeleteInstanceRequest, Google::Longrunning::Operation
-            # ApplyParameters will update current set of Parameters to the set of
-            # specified nodes of the Memcached Instance.
-            rpc :ApplyParameters, Google::Cloud::Memcache::V1beta2::ApplyParametersRequest, Google::Longrunning::Operation
+            rpc :DeleteInstance, ::Google::Cloud::Memcache::V1beta2::DeleteInstanceRequest, ::Google::Longrunning::Operation
+            # `ApplyParameters` restarts the set of specified nodes in order to update
+            # them to the current set of parameters for the Memcached Instance.
+            rpc :ApplyParameters, ::Google::Cloud::Memcache::V1beta2::ApplyParametersRequest, ::Google::Longrunning::Operation
+            # Updates software on the selected nodes of the Instance.
+            rpc :ApplySoftwareUpdate, ::Google::Cloud::Memcache::V1beta2::ApplySoftwareUpdateRequest, ::Google::Longrunning::Operation
           end
 
           Stub = Service.rpc_stub_class

data/lib/google/cloud/memcache/v1beta2/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Memcache
       module V1beta2
-        VERSION = "0.1.2"
+        VERSION = "0.2.0"
       end
     end
   end

data/proto_docs/google/api/field_behavior.rb

@@ -54,6 +54,12 @@ module Google
       # This indicates that the field may be set once in a request to create a
       # resource, but may not be changed thereafter.
       IMMUTABLE = 5
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
     end
   end
 end

data/proto_docs/google/api/resource.rb

@@ -43,12 +43,12 @@ module Google
     #
     # The ResourceDescriptor Yaml config will look like:
     #
-    #    resources:
-    #    - type: "pubsub.googleapis.com/Topic"
-    #      name_descriptor:
-    #        - pattern: "projects/\\{project}/topics/\\{topic}"
-    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #          parent_name_extractor: "projects/\\{project}"
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
     #         }
     # @!attribute [rw] plural
     #   @return [::String]
-    #     The plural name used in the resource name, such as 'projects' for
-    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
-    #     field in k8s CRD spec
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
     # @!attribute [rw] singular
     #   @return [::String]
     #     The same concept of the `singular` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
     class ResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
         # that from being necessary once there are multiple patterns.)
         FUTURE_MULTI_PATTERN = 2
       end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
     end
 
     # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
     #             type: "pubsub.googleapis.com/Topic"
     #           }];
     #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
     # @!attribute [rw] child_type
     #   @return [::String]
     #     The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
     #
     #     Example:
     #
-    #       message ListLogEntriesRequest {
-    #         string parent = 1 [(google.api.resource_reference) = {
-    #           child_type: "logging.googleapis.com/LogEntry"
-    #         };
-    #       }
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
     class ResourceReference
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

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