google-cloud-redis 0.2.1 → 0.2.2

data/lib/google/cloud/redis/v1/cloud_redis_client_config.json

@@ -0,0 +1,51 @@
+{
+  "interfaces": {
+    "google.cloud.redis.v1.CloudRedis": {
+      "retry_codes": {
+        "idempotent": [
+          "DEADLINE_EXCEEDED",
+          "UNAVAILABLE"
+        ],
+        "non_idempotent": []
+      },
+      "retry_params": {
+        "default": {
+          "initial_retry_delay_millis": 100,
+          "retry_delay_multiplier": 1.3,
+          "max_retry_delay_millis": 60000,
+          "initial_rpc_timeout_millis": 20000,
+          "rpc_timeout_multiplier": 1.0,
+          "max_rpc_timeout_millis": 20000,
+          "total_timeout_millis": 600000
+        }
+      },
+      "methods": {
+        "ListInstances": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "GetInstance": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "CreateInstance": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "UpdateInstance": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "DeleteInstance": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        }
+      }
+    }
+  }
+}

data/lib/google/cloud/redis/v1/cloud_redis_pb.rb

@@ -0,0 +1,104 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/redis/v1/cloud_redis.proto
+
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/longrunning/operations_pb'
+require 'google/protobuf/field_mask_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.cloud.redis.v1.Instance" do
+    optional :name, :string, 1
+    optional :display_name, :string, 2
+    map :labels, :string, :string, 3
+    optional :location_id, :string, 4
+    optional :alternative_location_id, :string, 5
+    optional :redis_version, :string, 7
+    optional :reserved_ip_range, :string, 9
+    optional :host, :string, 10
+    optional :port, :int32, 11
+    optional :current_location_id, :string, 12
+    optional :create_time, :message, 13, "google.protobuf.Timestamp"
+    optional :state, :enum, 14, "google.cloud.redis.v1.Instance.State"
+    optional :status_message, :string, 15
+    map :redis_configs, :string, :string, 16
+    optional :tier, :enum, 17, "google.cloud.redis.v1.Instance.Tier"
+    optional :memory_size_gb, :int32, 18
+    optional :authorized_network, :string, 20
+  end
+  add_enum "google.cloud.redis.v1.Instance.State" do
+    value :STATE_UNSPECIFIED, 0
+    value :CREATING, 1
+    value :READY, 2
+    value :UPDATING, 3
+    value :DELETING, 4
+    value :REPAIRING, 5
+    value :MAINTENANCE, 6
+  end
+  add_enum "google.cloud.redis.v1.Instance.Tier" do
+    value :TIER_UNSPECIFIED, 0
+    value :BASIC, 1
+    value :STANDARD_HA, 3
+  end
+  add_message "google.cloud.redis.v1.ListInstancesRequest" do
+    optional :parent, :string, 1
+    optional :page_size, :int32, 2
+    optional :page_token, :string, 3
+  end
+  add_message "google.cloud.redis.v1.ListInstancesResponse" do
+    repeated :instances, :message, 1, "google.cloud.redis.v1.Instance"
+    optional :next_page_token, :string, 2
+  end
+  add_message "google.cloud.redis.v1.GetInstanceRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.redis.v1.CreateInstanceRequest" do
+    optional :parent, :string, 1
+    optional :instance_id, :string, 2
+    optional :instance, :message, 3, "google.cloud.redis.v1.Instance"
+  end
+  add_message "google.cloud.redis.v1.UpdateInstanceRequest" do
+    optional :update_mask, :message, 1, "google.protobuf.FieldMask"
+    optional :instance, :message, 2, "google.cloud.redis.v1.Instance"
+  end
+  add_message "google.cloud.redis.v1.DeleteInstanceRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.redis.v1.OperationMetadata" do
+    optional :create_time, :message, 1, "google.protobuf.Timestamp"
+    optional :end_time, :message, 2, "google.protobuf.Timestamp"
+    optional :target, :string, 3
+    optional :verb, :string, 4
+    optional :status_detail, :string, 5
+    optional :cancel_requested, :bool, 6
+    optional :api_version, :string, 7
+  end
+  add_message "google.cloud.redis.v1.LocationMetadata" do
+    map :available_zones, :string, :message, 1, "google.cloud.redis.v1.ZoneMetadata"
+  end
+  add_message "google.cloud.redis.v1.ZoneMetadata" do
+  end
+end
+
+module Google
+  module Cloud
+    module Redis
+      module V1
+        Instance = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.Instance").msgclass
+        Instance::State = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.Instance.State").enummodule
+        Instance::Tier = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.Instance.Tier").enummodule
+        ListInstancesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.ListInstancesRequest").msgclass
+        ListInstancesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.ListInstancesResponse").msgclass
+        GetInstanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.GetInstanceRequest").msgclass
+        CreateInstanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.CreateInstanceRequest").msgclass
+        UpdateInstanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.UpdateInstanceRequest").msgclass
+        DeleteInstanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.DeleteInstanceRequest").msgclass
+        OperationMetadata = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.OperationMetadata").msgclass
+        LocationMetadata = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.LocationMetadata").msgclass
+        ZoneMetadata = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.ZoneMetadata").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/redis/v1/cloud_redis_services_pb.rb

@@ -0,0 +1,91 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/redis/v1/cloud_redis.proto for package 'google.cloud.redis.v1'
+# Original file comments:
+# 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
+#
+#     http://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.
+#
+
+
+require 'grpc'
+require 'google/cloud/redis/v1/cloud_redis_pb'
+
+module Google
+  module Cloud
+    module Redis
+      module V1
+        module CloudRedis
+          # Configures and manages Cloud Memorystore for Redis instances
+          #
+          # Google Cloud Memorystore for Redis v1
+          #
+          # The `redis.googleapis.com` service implements the Google Cloud Memorystore
+          # for Redis API and defines the following resource model for managing Redis
+          # instances:
+          # * The service works with a collection of cloud projects, named: `/projects/*`
+          # * Each project has a collection of available locations, named: `/locations/*`
+          # * Each location has a collection of Redis instances, named: `/instances/*`
+          # * As such, Redis 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:
+          # * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.redis.v1.CloudRedis'
+
+            # Lists all Redis instances owned by a project in either the specified
+            # location (region) or all locations.
+            #
+            # The location should have the following format:
+            # * `projects/\\{project_id}/locations/\\{location_id}`
+            #
+            # If `location_id` is specified as `-` (wildcard), then all regions
+            # available to the project are queried, and the results are aggregated.
+            rpc :ListInstances, ListInstancesRequest, ListInstancesResponse
+            # Gets the details of a specific Redis instance.
+            rpc :GetInstance, GetInstanceRequest, Instance
+            # Creates a Redis instance based on the specified tier and memory size.
+            #
+            # By default, the instance is accessible from the project's
+            # [default network](/compute/docs/networks-and-firewalls#networks).
+            #
+            # The creation is executed asynchronously and callers may check the returned
+            # operation to track its progress. Once the operation is completed the Redis
+            # instance will be fully functional. Completed longrunning.Operation will
+            # contain the new instance object in the response field.
+            #
+            # The returned operation is automatically deleted after a few hours, so there
+            # is no need to call DeleteOperation.
+            rpc :CreateInstance, CreateInstanceRequest, Google::Longrunning::Operation
+            # Updates the metadata and configuration of a specific Redis instance.
+            #
+            # Completed longrunning.Operation will contain the new instance object
+            # in the response field. The returned operation is automatically deleted
+            # after a few hours, so there is no need to call DeleteOperation.
+            rpc :UpdateInstance, UpdateInstanceRequest, Google::Longrunning::Operation
+            # Deletes a specific Redis instance.  Instance stops serving and data is
+            # deleted.
+            rpc :DeleteInstance, DeleteInstanceRequest, Google::Longrunning::Operation
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/redis/v1/credentials.rb

@@ -0,0 +1,41 @@
+# 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.
+
+
+require "googleauth"
+
+module Google
+  module Cloud
+    module Redis
+      module V1
+        class Credentials < Google::Auth::Credentials
+          SCOPE = [
+            "https://www.googleapis.com/auth/cloud-platform"
+          ].freeze
+          PATH_ENV_VARS = %w(REDIS_CREDENTIALS
+                             REDIS_KEYFILE
+                             GOOGLE_CLOUD_CREDENTIALS
+                             GOOGLE_CLOUD_KEYFILE
+                             GCLOUD_KEYFILE)
+          JSON_ENV_VARS = %w(REDIS_CREDENTIALS_JSON
+                             REDIS_KEYFILE_JSON
+                             GOOGLE_CLOUD_CREDENTIALS_JSON
+                             GOOGLE_CLOUD_KEYFILE_JSON
+                             GCLOUD_KEYFILE_JSON)
+          DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/redis/v1/doc/google/cloud/redis/v1/cloud_redis.rb

@@ -0,0 +1,283 @@
+# 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 Cloud
+    module Redis
+      module V1
+        # A Google Cloud Redis 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: Redis instances are managed and addressed at regional level so
+        #     location_id here refers to a GCP region; however, users may choose which
+        #     specific zone (or collection of zones for cross-zone instances) an instance
+        #     should be provisioned in. Refer to [location_id] and
+        #     [alternative_location_id] fields for more details.
+        # @!attribute [rw] display_name
+        #   @return [String]
+        #     An arbitrary and optional user-provided name for the instance.
+        # @!attribute [rw] labels
+        #   @return [Hash{String => String}]
+        #     Resource labels to represent user provided metadata
+        # @!attribute [rw] location_id
+        #   @return [String]
+        #     Optional. The zone where the instance will be provisioned. If not provided,
+        #     the service will choose a zone for the instance. For STANDARD_HA tier,
+        #     instances will be created across two zones for protection against zonal
+        #     failures. If [alternative_location_id] is also provided, it must be
+        #     different from [location_id].
+        # @!attribute [rw] alternative_location_id
+        #   @return [String]
+        #     Optional. Only applicable to STANDARD_HA tier which protects the instance
+        #     against zonal failures by provisioning it across two zones. If provided, it
+        #     must be a different zone from the one provided in [location_id].
+        # @!attribute [rw] redis_version
+        #   @return [String]
+        #     Optional. The version of Redis software.
+        #     If not provided, latest supported version will be used. Updating the
+        #     version will perform an upgrade/downgrade to the new version. Currently,
+        #     the supported values are +REDIS_3_2+ for Redis 3.2.
+        # @!attribute [rw] reserved_ip_range
+        #   @return [String]
+        #     Optional. The CIDR range of internal addresses that are reserved for this
+        #     instance. If not provided, the service will choose an unused /29 block,
+        #     for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
+        #     and non-overlapping with existing subnets in an authorized network.
+        # @!attribute [rw] host
+        #   @return [String]
+        #     Output only. Hostname or IP address of the exposed Redis endpoint used by
+        #     clients to connect to the service.
+        # @!attribute [rw] port
+        #   @return [Integer]
+        #     Output only. The port number of the exposed Redis endpoint.
+        # @!attribute [rw] current_location_id
+        #   @return [String]
+        #     Output only. The current zone where the Redis endpoint is placed. For Basic
+        #     Tier instances, this will always be the same as the [location_id]
+        #     provided by the user at creation time. For Standard Tier instances,
+        #     this can be either [location_id] or [alternative_location_id] and can
+        #     change after a failover event.
+        # @!attribute [rw] create_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Output only. The time the instance was created.
+        # @!attribute [rw] state
+        #   @return [Google::Cloud::Redis::V1::Instance::State]
+        #     Output only. The current state of this instance.
+        # @!attribute [rw] status_message
+        #   @return [String]
+        #     Output only. Additional information about the current status of this
+        #     instance, if available.
+        # @!attribute [rw] redis_configs
+        #   @return [Hash{String => String}]
+        #     Optional. Redis configuration parameters, according to
+        #     http://redis.io/topics/config. Currently, the only supported parameters
+        #     are:
+        #
+        #     * maxmemory-policy
+        #       * notify-keyspace-events
+        # @!attribute [rw] tier
+        #   @return [Google::Cloud::Redis::V1::Instance::Tier]
+        #     Required. The service tier of the instance.
+        # @!attribute [rw] memory_size_gb
+        #   @return [Integer]
+        #     Required. Redis memory size in GiB.
+        # @!attribute [rw] authorized_network
+        #   @return [String]
+        #     Optional. The full name of the Google Compute Engine
+        #     [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the
+        #     instance is connected. If left unspecified, the +default+ network
+        #     will be used.
+        class Instance
+          # Represents the different states of a Redis instance.
+          module State
+            # Not set.
+            STATE_UNSPECIFIED = 0
+
+            # Redis instance is being created.
+            CREATING = 1
+
+            # Redis instance has been created and is fully usable.
+            READY = 2
+
+            # Redis instance configuration is being updated. Certain kinds of updates
+            # may cause the instance to become unusable while the update is in
+            # progress.
+            UPDATING = 3
+
+            # Redis instance is being deleted.
+            DELETING = 4
+
+            # Redis instance is being repaired and may be unusable. Details can be
+            # found in the +status_message+ field.
+            REPAIRING = 5
+
+            # Maintenance is being performed on this Redis instance.
+            MAINTENANCE = 6
+          end
+
+          # Available service tiers to choose from
+          module Tier
+            # Not set.
+            TIER_UNSPECIFIED = 0
+
+            # BASIC tier: standalone instance
+            BASIC = 1
+
+            # STANDARD_HA tier: highly available primary/replica instances
+            STANDARD_HA = 3
+          end
+        end
+
+        # Request for {Google::Cloud::Redis::V1::CloudRedis::ListInstances ListInstances}.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Required. The resource name of the instance location using the form:
+        #         +projects/\\{project_id}/locations/\\{location_id}+
+        #     where +location_id+ refers to a GCP region
+        # @!attribute [rw] page_size
+        #   @return [Integer]
+        #     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
+        #     {CloudRedis::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.
+        class ListInstancesRequest; end
+
+        # Response for {Google::Cloud::Redis::V1::CloudRedis::ListInstances ListInstances}.
+        # @!attribute [rw] instances
+        #   @return [Array<Google::Cloud::Redis::V1::Instance>]
+        #     A list of Redis instances in the project in the specified location,
+        #     or across all locations.
+        #
+        #     If the +location_id+ in the parent field of the request is "-", all regions
+        #     available to the project are queried, and the results aggregated.
+        #     If in such an aggregated query a location is unavailable, a dummy Redis
+        #     entry is included in the response with the "name" field set to a value of
+        #     the form projects/\\{project_id}/locations/\\{location_id}/instances/- and the
+        #     "status" field set to ERROR and "status_message" field set to "location not
+        #     available for ListInstances".
+        # @!attribute [rw] next_page_token
+        #   @return [String]
+        #     Token to retrieve the next page of results, or empty if there are no more
+        #     results in the list.
+        class ListInstancesResponse; end
+
+        # Request for {Google::Cloud::Redis::V1::CloudRedis::GetInstance GetInstance}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. Redis instance resource name using the form:
+        #         +projects/\\{project_id}/locations/\\{location_id}/instances/\\{instance_id}+
+        #     where +location_id+ refers to a GCP region
+        class GetInstanceRequest; end
+
+        # Request for {Google::Cloud::Redis::V1::CloudRedis::CreateInstance CreateInstance}.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     Required. The resource name of the instance location using the form:
+        #         +projects/\\{project_id}/locations/\\{location_id}+
+        #     where +location_id+ refers to a GCP region
+        # @!attribute [rw] instance_id
+        #   @return [String]
+        #     Required. The logical name of the Redis instance in the customer project
+        #     with the following restrictions:
+        #
+        #     * Must contain only lowercase letters, numbers, and hyphens.
+        #     * Must start with a letter.
+        #     * Must be between 1-40 characters.
+        #     * Must end with a number or a letter.
+        #     * Must be unique within the customer project / location
+        # @!attribute [rw] instance
+        #   @return [Google::Cloud::Redis::V1::Instance]
+        #     Required. A Redis [Instance] resource
+        class CreateInstanceRequest; end
+
+        # Request for {Google::Cloud::Redis::V1::CloudRedis::UpdateInstance UpdateInstance}.
+        # @!attribute [rw] update_mask
+        #   @return [Google::Protobuf::FieldMask]
+        #     Required. Mask of fields to update. At least one path must be supplied in
+        #     this field. The elements of the repeated paths field may only include these
+        #     fields from {CloudRedis::Instance Instance}:
+        #
+        #     * +displayName+
+        #       * +labels+
+        #     * +memorySizeGb+
+        #       * +redisConfig+
+        # @!attribute [rw] instance
+        #   @return [Google::Cloud::Redis::V1::Instance]
+        #     Required. Update description.
+        #     Only fields specified in update_mask are updated.
+        class UpdateInstanceRequest; end
+
+        # Request for {Google::Cloud::Redis::V1::CloudRedis::DeleteInstance DeleteInstance}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. Redis instance resource name using the form:
+        #         +projects/\\{project_id}/locations/\\{location_id}/instances/\\{instance_id}+
+        #     where +location_id+ refers to a GCP region
+        class DeleteInstanceRequest; end
+
+        # Represents the v1 metadata of the long-running operation.
+        # @!attribute [rw] create_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Creation timestamp.
+        # @!attribute [rw] end_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     End timestamp.
+        # @!attribute [rw] target
+        #   @return [String]
+        #     Operation target.
+        # @!attribute [rw] verb
+        #   @return [String]
+        #     Operation verb.
+        # @!attribute [rw] status_detail
+        #   @return [String]
+        #     Operation status details.
+        # @!attribute [rw] cancel_requested
+        #   @return [true, false]
+        #     Specifies if cancellation was requested for the operaiton.
+        # @!attribute [rw] api_version
+        #   @return [String]
+        #     API version.
+        class OperationMetadata; end
+
+        # This location metadata represents additional configuration options for a
+        # given location where a Redis instance may be created. All fields are output
+        # only. It is returned as content of the
+        # +google.cloud.location.Location.metadata+ field.
+        # @!attribute [rw] available_zones
+        #   @return [Hash{String => Google::Cloud::Redis::V1::ZoneMetadata}]
+        #     Output only. The set of available zones in the location. The map is keyed
+        #     by the lowercase ID of each zone, as defined by GCE. These keys can be
+        #     specified in +location_id+ or +alternative_location_id+ fields when
+        #     creating a Redis instance.
+        class LocationMetadata; end
+
+        # Defines specific information for a particular zone. Currently empty and
+        # reserved for future use only.
+        class ZoneMetadata; end
+      end
+    end
+  end
+end