proto_docs/google/cloud/memcache/v1/cloud_memcache.rb in google-cloud-memcache-v1-0.3.0 vs proto_docs/google/cloud/memcache/v1/cloud_memcache.rb in google-cloud-memcache-v1-0.4.0

- old
+ new

@@ -19,23 +19,24 @@ module Google module Cloud module Memcache module V1 + # 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::V1::Instance#zones zones} field for more details. # @!attribute [rw] display_name # @return [::String] - # 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}] # Resource labels to represent user-provided metadata. # Refer to cloud documentation on labels for more details. @@ -46,11 +47,11 @@ # [network](/compute/docs/networks-and-firewalls#networks) to which the # instance is connected. If left unspecified, the `default` network # will be used. # @!attribute [rw] zones # @return [::Array<::String>] - # 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. # @!attribute [rw] node_count # @return [::Integer] @@ -60,21 +61,21 @@ # Required. Configuration for Memcached nodes. # @!attribute [rw] memcache_version # @return [::Google::Cloud::Memcache::V1::MemcacheVersion] # 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 # @return [::Google::Cloud::Memcache::V1::MemcacheParameters] - # Optional: User defined parameters to apply to the memcached process + # User defined parameters to apply to the memcached process # on each node. # @!attribute [r] memcache_nodes # @return [::Array<::Google::Cloud::Memcache::V1::Instance::Node>] # Output only. List of Memcached nodes. - # Refer to [Node] message for more details. + # Refer to {::Google::Cloud::Memcache::V1::Instance::Node Node} message for more details. # @!attribute [r] create_time # @return [::Google::Protobuf::Timestamp] # Output only. The time the instance was created. # @!attribute [r] update_time # @return [::Google::Protobuf::Timestamp] @@ -88,14 +89,22 @@ # System automatically determines the full memcached version for an instance # based on the input MemcacheVersion. # The full version format will be "memcached-1.5.16". # @!attribute [rw] instance_messages # @return [::Array<::Google::Cloud::Memcache::V1::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 [rw] maintenance_policy + # @return [::Google::Cloud::Memcache::V1::MaintenancePolicy] + # The maintenance policy for the instance. If not provided, + # the maintenance event will be performed based on Memorystore + # internal rollout schedule. + # @!attribute [r] maintenance_schedule + # @return [::Google::Cloud::Memcache::V1::MaintenanceSchedule] + # Output only. Published maintenance schedule. class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Configuration for a Memcached Node. @@ -190,18 +199,109 @@ CREATING = 1 # Memcached instance has been created and ready to be used. READY = 2 + # Memcached instance is updating configuration such as maintenance policy + # and schedule. + UPDATING = 3 + # Memcached instance is being deleted. DELETING = 4 # Memcached instance is going through maintenance, e.g. data plane rollout. PERFORMING_MAINTENANCE = 5 end end + # Maintenance policy per instance. + # @!attribute [r] create_time + # @return [::Google::Protobuf::Timestamp] + # Output only. The time when the policy was created. + # @!attribute [r] update_time + # @return [::Google::Protobuf::Timestamp] + # Output only. The time when the policy was updated. + # @!attribute [rw] description + # @return [::String] + # Description of what this policy is for. Create/Update methods + # return INVALID_ARGUMENT if the length is greater than 512. + # @!attribute [rw] weekly_maintenance_window + # @return [::Array<::Google::Cloud::Memcache::V1::WeeklyMaintenanceWindow>] + # Required. Maintenance window that is applied to resources covered by this + # policy. Minimum 1. For the current version, the maximum number of + # weekly_maintenance_windows is expected to be one. + class MaintenancePolicy + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Time window specified for weekly operations. + # @!attribute [rw] day + # @return [::Google::Type::DayOfWeek] + # Required. Allows to define schedule that runs specified day of the week. + # @!attribute [rw] start_time + # @return [::Google::Type::TimeOfDay] + # Required. Start time of the window in UTC. + # @!attribute [rw] duration + # @return [::Google::Protobuf::Duration] + # Required. Duration of the time window. + class WeeklyMaintenanceWindow + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Upcoming maintenance schedule. + # @!attribute [r] start_time + # @return [::Google::Protobuf::Timestamp] + # Output only. The start time of any upcoming scheduled maintenance for this instance. + # @!attribute [r] end_time + # @return [::Google::Protobuf::Timestamp] + # Output only. The end time of any upcoming scheduled maintenance for this instance. + # @!attribute [r] schedule_deadline_time + # @return [::Google::Protobuf::Timestamp] + # Output only. The deadline that the maintenance schedule start time can not go beyond, + # including reschedule. + class MaintenanceSchedule + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Request for {::Google::Cloud::Memcache::V1::CloudMemcache::Client#reschedule_maintenance RescheduleMaintenance}. + # @!attribute [rw] instance + # @return [::String] + # Required. Memcache instance resource name using the form: + # `projects/{project_id}/locations/{location_id}/instances/{instance_id}` + # where `location_id` refers to a GCP region. + # @!attribute [rw] reschedule_type + # @return [::Google::Cloud::Memcache::V1::RescheduleMaintenanceRequest::RescheduleType] + # Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well. + # @!attribute [rw] schedule_time + # @return [::Google::Protobuf::Timestamp] + # Timestamp when the maintenance shall be rescheduled to if + # reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for + # example `2012-11-15T16:19:00.094Z`. + class RescheduleMaintenanceRequest + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + + # Reschedule options. + module RescheduleType + # Not set. + RESCHEDULE_TYPE_UNSPECIFIED = 0 + + # If the user wants to schedule the maintenance to happen now. + IMMEDIATE = 1 + + # If the user wants to use the existing maintenance policy to find the + # next available window. + NEXT_AVAILABLE_WINDOW = 2 + + # If the user wants to reschedule the maintenance to a specific time. + SPECIFIC_TIME = 3 + end + end + # Request for {::Google::Cloud::Memcache::V1::CloudMemcache::Client#list_instances ListInstances}. # @!attribute [rw] parent # @return [::String] # Required. The resource name of the instance location using the form: # `projects/{project_id}/locations/{location_id}` @@ -209,22 +309,21 @@ # @!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 - # [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::V1::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). class ListInstancesRequest include ::Google::Protobuf::MessageExts @@ -275,13 +374,13 @@ # # * 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 user project / location + # * Must be unique within the user project / location. # - # If any of the above are not met, will raise an invalid argument error. + # If any of the above are not met, the API raises an invalid argument error. # @!attribute [rw] instance # @return [::Google::Cloud::Memcache::V1::Instance] # Required. A Memcached Instance class CreateInstanceRequest include ::Google::Protobuf::MessageExts @@ -290,10 +389,11 @@ # Request for {::Google::Cloud::Memcache::V1::CloudMemcache::Client#update_instance UpdateInstance}. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. Mask of fields to update. + # # * `displayName` # @!attribute [rw] instance # @return [::Google::Cloud::Memcache::V1::Instance] # Required. A Memcached Instance. # Only fields specified in update_mask are updated. @@ -318,16 +418,16 @@ # @return [::String] # Required. Resource name of the Memcached instance for which parameter group updates # 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 end @@ -349,12 +449,13 @@ # @!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. + # 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 [rw] params # @return [::Google::Protobuf::Map{::String => ::String}] # User defined set of parameters to use in the memcached process. class MemcacheParameters include ::Google::Protobuf::MessageExts @@ -394,9 +495,34 @@ # corresponding to `Code.CANCELLED`. # @!attribute [r] api_version # @return [::String] # Output only. API version used to start the operation. class OperationMetadata + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Metadata for the given `::Google::Cloud::Location::Location`. + # @!attribute [r] available_zones + # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Memcache::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 the `zones` field when creating a Memcached instance. + class LocationMetadata + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + + # @!attribute [rw] key + # @return [::String] + # @!attribute [rw] value + # @return [::Google::Cloud::Memcache::V1::ZoneMetadata] + class AvailableZonesEntry + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + end + + class ZoneMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Memcached versions supported by our service.