com.google.cloud.memcache.v1.cloud_memcache

Members list

Concise view

Type members

Classlikes

final case class ApplyParametersRequest(name: String, nodeIds: Seq[String], applyAll: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ApplyParametersRequest]

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 GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ApplyParametersRequest extends GeneratedMessageCompanion[ApplyParametersRequest]

Attributes

Companion:
class
Source:
ApplyParametersRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ApplyParametersRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
trait CloudMemcache[F[_]]

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 Object
trait Matchable
class Any

Attributes

Companion:
trait
Source:
CloudMemcache.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object CloudMemcacheProto extends GeneratedFileObject

Attributes

Source:
CloudMemcacheProto.scala
Graph
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class CreateInstanceRequest(parent: String, instanceId: String, instance: Option[Instance], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[CreateInstanceRequest]

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} where location_id refers to a GCP region

Companion:
object
Source:
CreateInstanceRequest.scala
Graph
Supertypes
trait Updatable[CreateInstanceRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CreateInstanceRequest extends GeneratedMessageCompanion[CreateInstanceRequest]

Attributes

Companion:
class
Source:
CreateInstanceRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CreateInstanceRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class DeleteInstanceRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[DeleteInstanceRequest]

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} where location_id refers to a GCP region

Companion:
object
Source:
DeleteInstanceRequest.scala
Graph
Supertypes
trait Updatable[DeleteInstanceRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object DeleteInstanceRequest extends GeneratedMessageCompanion[DeleteInstanceRequest]

Attributes

Companion:
class
Source:
DeleteInstanceRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DeleteInstanceRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class GetInstanceRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[GetInstanceRequest]

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} where location_id refers to a GCP region

Companion:
object
Source:
GetInstanceRequest.scala
Graph
Supertypes
trait Updatable[GetInstanceRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GetInstanceRequest extends GeneratedMessageCompanion[GetInstanceRequest]

Attributes

Companion:
class
Source:
GetInstanceRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetInstanceRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class Instance(name: String, displayName: String, labels: Map[String, String], authorizedNetwork: String, zones: Seq[String], nodeCount: Int, nodeConfig: Option[NodeConfig], memcacheVersion: MemcacheVersion, parameters: Option[MemcacheParameters], memcacheNodes: Seq[Node], createTime: Option[Timestamp], updateTime: Option[Timestamp], state: State, memcacheFullVersion: String, instanceMessages: Seq[InstanceMessage], discoveryEndpoint: String, maintenancePolicy: Option[MaintenancePolicy], maintenanceSchedule: Option[MaintenanceSchedule], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Instance]

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 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 [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
trait Updatable[Instance]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Instance extends GeneratedMessageCompanion[Instance]

Attributes

Companion:
class
Source:
Instance.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Instance]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListInstancesRequest(parent: String, pageSize: Int, pageToken: String, filter: String, orderBy: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListInstancesRequest]

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} where location_id refers to a GCP region

Companion:
object
Source:
ListInstancesRequest.scala
Graph
Supertypes
trait Updatable[ListInstancesRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListInstancesRequest extends GeneratedMessageCompanion[ListInstancesRequest]

Attributes

Companion:
class
Source:
ListInstancesRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListInstancesRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListInstancesResponse(instances: Seq[Instance], nextPageToken: String, unreachable: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListInstancesResponse]

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 GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListInstancesResponse extends GeneratedMessageCompanion[ListInstancesResponse]

Attributes

Companion:
class
Source:
ListInstancesResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListInstancesResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class LocationMetadata(availableZones: Map[String, ZoneMetadata], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[LocationMetadata]

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 GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object LocationMetadata extends GeneratedMessageCompanion[LocationMetadata]

Attributes

Companion:
class
Source:
LocationMetadata.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[LocationMetadata]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class MaintenancePolicy(createTime: Option[Timestamp], updateTime: Option[Timestamp], description: String, weeklyMaintenanceWindow: Seq[WeeklyMaintenanceWindow], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[MaintenancePolicy]

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 GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object MaintenancePolicy extends GeneratedMessageCompanion[MaintenancePolicy]

Attributes

Companion:
class
Source:
MaintenancePolicy.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[MaintenancePolicy]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class MaintenanceSchedule(startTime: Option[Timestamp], endTime: Option[Timestamp], scheduleDeadlineTime: Option[Timestamp], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[MaintenanceSchedule]

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 GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object MaintenanceSchedule extends GeneratedMessageCompanion[MaintenanceSchedule]

Attributes

Companion:
class
Source:
MaintenanceSchedule.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[MaintenanceSchedule]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class MemcacheParameters(id: String, params: Map[String, String], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[MemcacheParameters]

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 GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object MemcacheParameters extends GeneratedMessageCompanion[MemcacheParameters]

Attributes

Companion:
class
Source:
MemcacheParameters.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[MemcacheParameters]
trait Serializable
class Object
trait Matchable
class Any
Self type
sealed abstract class MemcacheVersion(val value: Int) extends GeneratedEnum

Memcached versions supported by our service.

Memcached versions supported by our service.

Attributes

Companion:
object
Source:
MemcacheVersion.scala
Graph
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
object MemcacheVersion extends GeneratedEnumCompanion[MemcacheVersion]

Attributes

Companion:
class
Source:
MemcacheVersion.scala
Graph
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[MemcacheVersion]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class OperationMetadata(createTime: Option[Timestamp], endTime: Option[Timestamp], target: String, verb: String, statusDetail: String, cancelRequested: Boolean, apiVersion: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[OperationMetadata]

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 GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object OperationMetadata extends GeneratedMessageCompanion[OperationMetadata]

Attributes

Companion:
class
Source:
OperationMetadata.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[OperationMetadata]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class RescheduleMaintenanceRequest(instance: String, rescheduleType: RescheduleType, scheduleTime: Option[Timestamp], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[RescheduleMaintenanceRequest]

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} where location_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 GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object RescheduleMaintenanceRequest extends GeneratedMessageCompanion[RescheduleMaintenanceRequest]

Attributes

Companion:
class
Source:
RescheduleMaintenanceRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RescheduleMaintenanceRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class UpdateInstanceRequest(updateMask: Option[FieldMask], instance: Option[Instance], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[UpdateInstanceRequest]

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 GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object UpdateInstanceRequest extends GeneratedMessageCompanion[UpdateInstanceRequest]

Attributes

Companion:
class
Source:
UpdateInstanceRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateInstanceRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class UpdateParametersRequest(name: String, updateMask: Option[FieldMask], parameters: Option[MemcacheParameters], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[UpdateParametersRequest]

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 GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object UpdateParametersRequest extends GeneratedMessageCompanion[UpdateParametersRequest]

Attributes

Companion:
class
Source:
UpdateParametersRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateParametersRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class WeeklyMaintenanceWindow(day: DayOfWeek, startTime: Option[TimeOfDay], duration: Option[Duration], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[WeeklyMaintenanceWindow]

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 GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object WeeklyMaintenanceWindow extends GeneratedMessageCompanion[WeeklyMaintenanceWindow]

Attributes

Companion:
class
Source:
WeeklyMaintenanceWindow.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[WeeklyMaintenanceWindow]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ZoneMetadata(unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ZoneMetadata]

Attributes

Companion:
object
Source:
ZoneMetadata.scala
Graph
Supertypes
trait Updatable[ZoneMetadata]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ZoneMetadata extends GeneratedMessageCompanion[ZoneMetadata]

Attributes

Companion:
class
Source:
ZoneMetadata.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ZoneMetadata]
trait Serializable
class Object
trait Matchable
class Any
Self type