com.google.cloud.memcache.v1.cloud

Request for [ApplyParameters][google.cloud.memcache.v1.CloudMemcache.ApplyParameters].

Value parameters

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.

Attributes

Companion: object
Source: ApplyParametersRequest.scala
Supertypes: trait Updatable[ApplyParametersRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ApplyParametersRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ApplyParametersRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ApplyParametersRequest.type

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
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: trait
Source: CloudMemcache.scala
Supertypes: class Object

trait Matchable

class Any
Self type: CloudMemcache.type

Attributes

Source: CloudMemcacheProto.scala
Supertypes: class GeneratedFileObject

class Object

trait Matchable

class Any
Self type: CloudMemcacheProto.type

Request for [CreateInstance][google.cloud.memcache.v1.CloudMemcache.CreateInstance].

Value parameters

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

Attributes

Companion: object
Source: CreateInstanceRequest.scala
Supertypes: trait Updatable[CreateInstanceRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: CreateInstanceRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[CreateInstanceRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: CreateInstanceRequest.type

Request for [DeleteInstance][google.cloud.memcache.v1.CloudMemcache.DeleteInstance].

Value parameters

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

Attributes

Companion: object
Source: DeleteInstanceRequest.scala
Supertypes: trait Updatable[DeleteInstanceRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: DeleteInstanceRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[DeleteInstanceRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: DeleteInstanceRequest.type

Request for [GetInstance][google.cloud.memcache.v1.CloudMemcache.GetInstance].

Value parameters

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

Attributes

Companion: object
Source: GetInstanceRequest.scala
Supertypes: trait Updatable[GetInstanceRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: GetInstanceRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[GetInstanceRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: GetInstanceRequest.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, Updatable[Instance]

A Memorystore for Memcached instance

Value parameters

authorizedNetwork: The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) 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.

Attributes

Companion: object
Source: Instance.scala
Supertypes: trait Updatable[Instance]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: Instance.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[Instance]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: Instance.type

Request for [ListInstances][google.cloud.memcache.v1.CloudMemcache.ListInstances].

Value parameters

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

Attributes

Companion: object
Source: ListInstancesRequest.scala
Supertypes: trait Updatable[ListInstancesRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListInstancesRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListInstancesRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListInstancesRequest.type

Response for [ListInstances][google.cloud.memcache.v1.CloudMemcache.ListInstances].

Value parameters

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.

Attributes

Companion: object
Source: ListInstancesResponse.scala
Supertypes: trait Updatable[ListInstancesResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListInstancesResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListInstancesResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListInstancesResponse.type

Metadata for the given [google.cloud.location.Location][google.cloud.location.Location].

Value parameters

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.

Attributes

Companion: object
Source: LocationMetadata.scala
Supertypes: trait Updatable[LocationMetadata]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: LocationMetadata.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[LocationMetadata]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: LocationMetadata.type

Maintenance policy per instance.

Value parameters

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.

Attributes

Companion: object
Source: MaintenancePolicy.scala
Supertypes: trait Updatable[MaintenancePolicy]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: MaintenancePolicy.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[MaintenancePolicy]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: MaintenancePolicy.type

Upcoming maintenance schedule.

Value parameters

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.

Attributes

Companion: object
Source: MaintenanceSchedule.scala
Supertypes: trait Updatable[MaintenanceSchedule]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: MaintenanceSchedule.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[MaintenanceSchedule]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: MaintenanceSchedule.type

Value parameters

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.

Attributes

Companion: object
Source: MemcacheParameters.scala
Supertypes: trait Updatable[MemcacheParameters]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: MemcacheParameters.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[MemcacheParameters]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: MemcacheParameters.type

Memcached versions supported by our service.

Attributes

Companion: object
Source: MemcacheVersion.scala
Supertypes: trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: object MEMCACHE_1_5.type

object MEMCACHE_VERSION_UNSPECIFIED.type

trait Recognized

class Unrecognized

Attributes

Companion: class
Source: MemcacheVersion.scala
Supertypes: trait Sum

trait Mirror

trait GeneratedEnumCompanion[MemcacheVersion]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: MemcacheVersion.type

Represents the metadata of a long-running operation.

Value parameters

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.

Attributes

Companion: object
Source: OperationMetadata.scala
Supertypes: trait Updatable[OperationMetadata]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: OperationMetadata.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[OperationMetadata]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: OperationMetadata.type

Request for [RescheduleMaintenance][google.cloud.memcache.v1.CloudMemcache.RescheduleMaintenance].

Value parameters

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.

Attributes

Companion: object
Source: RescheduleMaintenanceRequest.scala
Supertypes: trait Updatable[RescheduleMaintenanceRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: RescheduleMaintenanceRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[RescheduleMaintenanceRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: RescheduleMaintenanceRequest.type

Request for [UpdateInstance][google.cloud.memcache.v1.CloudMemcache.UpdateInstance].

Value parameters

instance: Required. A Memcached Instance. Only fields specified in update_mask are updated.
updateMask: Required. Mask of fields to update. * displayName

Attributes

Companion: object
Source: UpdateInstanceRequest.scala
Supertypes: trait Updatable[UpdateInstanceRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: UpdateInstanceRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[UpdateInstanceRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: UpdateInstanceRequest.type

Request for [UpdateParameters][google.cloud.memcache.v1.CloudMemcache.UpdateParameters].

Value parameters

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.

Attributes

Companion: object
Source: UpdateParametersRequest.scala
Supertypes: trait Updatable[UpdateParametersRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: UpdateParametersRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[UpdateParametersRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: UpdateParametersRequest.type

Time window specified for weekly operations.

Value parameters

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.

Attributes

Companion: object
Source: WeeklyMaintenanceWindow.scala
Supertypes: trait Updatable[WeeklyMaintenanceWindow]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: WeeklyMaintenanceWindow.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[WeeklyMaintenanceWindow]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: WeeklyMaintenanceWindow.type

Attributes

Companion: object
Source: ZoneMetadata.scala
Supertypes: trait Updatable[ZoneMetadata]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ZoneMetadata.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ZoneMetadata]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ZoneMetadata.type

com.google.cloud.memcache.v1.cloud_memcache

Members list

Type members

Classlikes

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes