com.google.cloud.memcache.v1.cloud_memcache
Members list
Type members
Classlikes
Request for [ApplyParameters][google.cloud.memcache.v1.CloudMemcache.ApplyParameters].
Request for [ApplyParameters][google.cloud.memcache.v1.CloudMemcache.ApplyParameters].
Attributes
- applyAll
Whether to apply instance-level parameter group to all nodes. If set to true, users are restricted from specifying individual nodes, and
ApplyParameters
updates all nodes within the instance.- name
Required. Resource name of the Memcached instance for which parameter group updates should be applied.
- nodeIds
Nodes to which the instance-level parameter group is applied.
- Companion:
- object
- Source:
- ApplyParametersRequest.scala
- Graph
- Supertypes
- trait Updatable[ApplyParametersRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- ApplyParametersRequest.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[ApplyParametersRequest]trait Serializableclass Objecttrait Matchableclass Any
- Self type
Configures and manages Cloud Memorystore for Memcached instances.
Configures and manages Cloud Memorystore for Memcached instances.
The memcache.googleapis.com
service implements the Google Cloud Memorystore
for Memcached API and defines the following resource model for managing
Memorystore Memcached (also called Memcached below) 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 Memcached instances, named:
/instances/*
- As such, Memcached instances are resources of the form:
/projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note that location_id must be a GCP region
; for example:
projects/my-memcached-project/locations/us-central1/instances/my-memcached
Attributes
- Companion:
- object
- Source:
- CloudMemcache.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Attributes
- Companion:
- trait
- Source:
- CloudMemcache.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- CloudMemcache.type
Attributes
- Source:
- CloudMemcacheProto.scala
- Graph
- Supertypes
- class GeneratedFileObjectclass Objecttrait Matchableclass Any
- Self type
- CloudMemcacheProto.type
Request for [CreateInstance][google.cloud.memcache.v1.CloudMemcache.CreateInstance].
Request for [CreateInstance][google.cloud.memcache.v1.CloudMemcache.CreateInstance].
Attributes
- instance
Required. A Memcached Instance
- instanceId
Required. The logical name of the Memcached instance in the user 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 user project / location. If any of the above are not met, the API raises an invalid argument error.
- parent
Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
wherelocation_id
refers to a GCP region- Companion:
- object
- Source:
- CreateInstanceRequest.scala
- Graph
- Supertypes
- trait Updatable[CreateInstanceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- CreateInstanceRequest.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[CreateInstanceRequest]trait Serializableclass Objecttrait Matchableclass Any
- Self type
Request for [DeleteInstance][google.cloud.memcache.v1.CloudMemcache.DeleteInstance].
Request for [DeleteInstance][google.cloud.memcache.v1.CloudMemcache.DeleteInstance].
Attributes
- name
Required. Memcached instance resource name in the format:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region- Companion:
- object
- Source:
- DeleteInstanceRequest.scala
- Graph
- Supertypes
- trait Updatable[DeleteInstanceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- DeleteInstanceRequest.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[DeleteInstanceRequest]trait Serializableclass Objecttrait Matchableclass Any
- Self type
Request for [GetInstance][google.cloud.memcache.v1.CloudMemcache.GetInstance].
Request for [GetInstance][google.cloud.memcache.v1.CloudMemcache.GetInstance].
Attributes
- name
Required. Memcached instance resource name in the format:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region- Companion:
- object
- Source:
- GetInstanceRequest.scala
- Graph
- Supertypes
- trait Updatable[GetInstanceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- GetInstanceRequest.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[GetInstanceRequest]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- GetInstanceRequest.type
A Memorystore for Memcached instance
A Memorystore for Memcached instance
Attributes
- authorizedNetwork
The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the
default
network will be used.- createTime
Output only. The time the instance was created.
- discoveryEndpoint
Output only. Endpoint for the Discovery API.
- displayName
User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
- instanceMessages
List of messages that describe the current state of the Memcached instance.
- labels
Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
- maintenancePolicy
The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
- maintenanceSchedule
Output only. Published maintenance schedule.
- memcacheFullVersion
Output only. The full version of memcached server running on this instance. 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".
- memcacheNodes
Output only. List of Memcached nodes. Refer to [Node][google.cloud.memcache.v1.Instance.Node] message for more details.
- 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
. The minor version will be automatically determined by our system based on the latest supported minor version.- name
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 the regional level solocation_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 [zones][google.cloud.memcache.v1.Instance.zones] field for more details.- nodeConfig
Required. Configuration for Memcached nodes.
- nodeCount
Required. Number of nodes in the Memcached instance.
- parameters
User defined parameters to apply to the memcached process on each node.
- state
Output only. The state of this Memcached instance.
- updateTime
Output only. The time the instance was updated.
- zones
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.
- Companion:
- object
- Source:
- Instance.scala
- Graph
- Supertypes
Attributes
- Companion:
- class
- Source:
- Instance.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[Instance]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- Instance.type
Request for [ListInstances][google.cloud.memcache.v1.CloudMemcache.ListInstances].
Request for [ListInstances][google.cloud.memcache.v1.CloudMemcache.ListInstances].
Attributes
- filter
List filter. For example, exclude all Memcached instances with name as my-instance by specifying
"name != my-instance"
.- orderBy
Sort results. Supported values are "name", "name desc" or "" (unsorted).
- pageSize
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
][google.cloud.memcache.v1.ListInstancesResponse.next_page_token] to determine if there are more instances left to be queried.- pageToken
The
next_page_token
value returned from a previous List request, if any.- parent
Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
wherelocation_id
refers to a GCP region- Companion:
- object
- Source:
- ListInstancesRequest.scala
- Graph
- Supertypes
- trait Updatable[ListInstancesRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- ListInstancesRequest.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[ListInstancesRequest]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- ListInstancesRequest.type
Response for [ListInstances][google.cloud.memcache.v1.CloudMemcache.ListInstances].
Response for [ListInstances][google.cloud.memcache.v1.CloudMemcache.ListInstances].
Attributes
- instances
A list of Memcached 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.- nextPageToken
Token to retrieve the next page of results, or empty if there are no more results in the list.
- unreachable
Locations that could not be reached.
- Companion:
- object
- Source:
- ListInstancesResponse.scala
- Graph
- Supertypes
- trait Updatable[ListInstancesResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- ListInstancesResponse.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[ListInstancesResponse]trait Serializableclass Objecttrait Matchableclass Any
- Self type
Metadata for the given [google.cloud.location.Location][google.cloud.location.Location].
Metadata for the given [google.cloud.location.Location][google.cloud.location.Location].
Attributes
- availableZones
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.- Companion:
- object
- Source:
- LocationMetadata.scala
- Graph
- Supertypes
- trait Updatable[LocationMetadata]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- LocationMetadata.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[LocationMetadata]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- LocationMetadata.type
Maintenance policy per instance.
Maintenance policy per instance.
Attributes
- createTime
Output only. The time when the policy was created.
- description
Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
- updateTime
Output only. The time when the policy was updated.
- 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.
- Companion:
- object
- Source:
- MaintenancePolicy.scala
- Graph
- Supertypes
- trait Updatable[MaintenancePolicy]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- MaintenancePolicy.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[MaintenancePolicy]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- MaintenancePolicy.type
Upcoming maintenance schedule.
Upcoming maintenance schedule.
Attributes
- endTime
Output only. The end time of any upcoming scheduled maintenance for this instance.
- scheduleDeadlineTime
Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
- startTime
Output only. The start time of any upcoming scheduled maintenance for this instance.
- Companion:
- object
- Source:
- MaintenanceSchedule.scala
- Graph
- Supertypes
- trait Updatable[MaintenanceSchedule]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- MaintenanceSchedule.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[MaintenanceSchedule]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- MaintenanceSchedule.type
Attributes
- id
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. A discrepancy between parameter ids can inform users that they may need to take action to apply parameters on nodes.
- params
User defined set of parameters to use in the memcached process.
- Companion:
- object
- Source:
- MemcacheParameters.scala
- Graph
- Supertypes
- trait Updatable[MemcacheParameters]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- MemcacheParameters.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[MemcacheParameters]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- MemcacheParameters.type
Memcached versions supported by our service.
Memcached versions supported by our service.
Attributes
- Companion:
- object
- Source:
- MemcacheVersion.scala
- Graph
- Supertypes
- Known subtypes
Attributes
- Companion:
- class
- Source:
- MemcacheVersion.scala
- Graph
- Supertypes
- trait Sumtrait Mirrortrait GeneratedEnumCompanion[MemcacheVersion]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- MemcacheVersion.type
Represents the metadata of a long-running operation.
Represents the metadata of a long-running operation.
Attributes
- apiVersion
Output only. API version used to start the operation.
- cancelRequested
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
.- createTime
Output only. Time when the operation was created.
- endTime
Output only. Time when the operation finished running.
- statusDetail
Output only. Human-readable status of the operation, if any.
- target
Output only. Server-defined resource path for the target of the operation.
- verb
Output only. Name of the verb executed by the operation.
- Companion:
- object
- Source:
- OperationMetadata.scala
- Graph
- Supertypes
- trait Updatable[OperationMetadata]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- OperationMetadata.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[OperationMetadata]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- OperationMetadata.type
Request for [RescheduleMaintenance][google.cloud.memcache.v1.CloudMemcache.RescheduleMaintenance].
Request for [RescheduleMaintenance][google.cloud.memcache.v1.CloudMemcache.RescheduleMaintenance].
Attributes
- instance
Required. Memcache instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.- rescheduleType
Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
- scheduleTime
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
.- Companion:
- object
- Source:
- RescheduleMaintenanceRequest.scala
- Graph
- Supertypes
- trait Updatable[RescheduleMaintenanceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- RescheduleMaintenanceRequest.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[RescheduleMaintenanceRequest]trait Serializableclass Objecttrait Matchableclass Any
- Self type
Request for [UpdateInstance][google.cloud.memcache.v1.CloudMemcache.UpdateInstance].
Request for [UpdateInstance][google.cloud.memcache.v1.CloudMemcache.UpdateInstance].
Attributes
- instance
Required. A Memcached Instance. Only fields specified in update_mask are updated.
- updateMask
Required. Mask of fields to update.
displayName
- Companion:
- object
- Source:
- UpdateInstanceRequest.scala
- Graph
- Supertypes
- trait Updatable[UpdateInstanceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- UpdateInstanceRequest.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[UpdateInstanceRequest]trait Serializableclass Objecttrait Matchableclass Any
- Self type
Request for [UpdateParameters][google.cloud.memcache.v1.CloudMemcache.UpdateParameters].
Request for [UpdateParameters][google.cloud.memcache.v1.CloudMemcache.UpdateParameters].
Attributes
- name
Required. Resource name of the Memcached instance for which the parameters should be updated.
- parameters
The parameters to apply to the instance.
- updateMask
Required. Mask of fields to update.
- Companion:
- object
- Source:
- UpdateParametersRequest.scala
- Graph
- Supertypes
- trait Updatable[UpdateParametersRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- UpdateParametersRequest.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[UpdateParametersRequest]trait Serializableclass Objecttrait Matchableclass Any
- Self type
Time window specified for weekly operations.
Time window specified for weekly operations.
Attributes
- day
Required. Allows to define schedule that runs specified day of the week.
- duration
Required. Duration of the time window.
- startTime
Required. Start time of the window in UTC.
- Companion:
- object
- Source:
- WeeklyMaintenanceWindow.scala
- Graph
- Supertypes
- trait Updatable[WeeklyMaintenanceWindow]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- WeeklyMaintenanceWindow.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[WeeklyMaintenanceWindow]trait Serializableclass Objecttrait Matchableclass Any
- Self type
Attributes
- Companion:
- object
- Source:
- ZoneMetadata.scala
- Graph
- Supertypes
- trait Updatable[ZoneMetadata]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- ZoneMetadata.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[ZoneMetadata]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- ZoneMetadata.type