memcache

import { memcache } from "https://googleapis.deno.dev/v1/memcache:v1.ts";

Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP.

class memcache {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsInstancesApplyParameters(name: string, req: ApplyParametersRequest): Promise<Operation>;

async projectsLocationsInstancesCreate(

parent: string,

req: Instance,

opts?: ProjectsLocationsInstancesCreateOptions,

): Promise<Operation>;

async projectsLocationsInstancesDelete(name: string): Promise<Operation>;

async projectsLocationsInstancesGet(name: string): Promise<Instance>;

async projectsLocationsInstancesList(parent: string, opts?: ProjectsLocationsInstancesListOptions): Promise<ListInstancesResponse>;

async projectsLocationsInstancesPatch(

name: string,

req: Instance,

opts?: ProjectsLocationsInstancesPatchOptions,

): Promise<Operation>;

async projectsLocationsInstancesRescheduleMaintenance(instance: string, req: RescheduleMaintenanceRequest): Promise<Operation>;

async projectsLocationsInstancesUpdateParameters(name: string, req: UpdateParametersRequest): Promise<Operation>;

async projectsLocationsInstancesUpgrade(name: string, req: GoogleCloudMemcacheV1UpgradeInstanceRequest): Promise<Operation>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

}

§Constructors

new memcache(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsInstancesApplyParameters(name: string, req: ApplyParametersRequest): Promise<Operation>

[src]

ApplyParameters restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.

@param name

Required. Resource name of the Memcached instance for which parameter group updates should be applied.

projectsLocationsInstancesCreate(parent: string, req: Instance, opts?: ProjectsLocationsInstancesCreateOptions): Promise<Operation>

[src]

Creates a new Instance in a given location.

@param 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

projectsLocationsInstancesDelete(name: string): Promise<Operation>

[src]

Deletes a single Instance.

@param 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

projectsLocationsInstancesGet(name: string): Promise<Instance>

[src]

Gets details of a single Instance.

@param 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

projectsLocationsInstancesList(parent: string, opts?: ProjectsLocationsInstancesListOptions): Promise<ListInstancesResponse>

[src]

Lists Instances in a given location.

@param 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

projectsLocationsInstancesPatch(name: string, req: Instance, opts?: ProjectsLocationsInstancesPatchOptions): Promise<Operation>

[src]

Updates an existing Instance in a given project and location.

@param 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 field for more details.

projectsLocationsInstancesRescheduleMaintenance(instance: string, req: RescheduleMaintenanceRequest): Promise<Operation>

[src]

Reschedules upcoming maintenance event.

@param 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.

projectsLocationsInstancesUpdateParameters(name: string, req: UpdateParametersRequest): Promise<Operation>

[src]

Updates the defined Memcached parameters for an existing instance. This method only stages the parameters, it must be followed by ApplyParameters to apply the parameters to nodes of the Memcached instance.

@param name

Required. Resource name of the Memcached instance for which the parameters should be updated.

projectsLocationsInstancesUpgrade(name: string, req: GoogleCloudMemcacheV1UpgradeInstanceRequest): Promise<Operation>

[src]

Upgrades the Memcache instance to a newer memcached engine version specified in the request.

@param name

Required. Memcache instance resource name using the form: projects/{project}/locations/{location}/instances/{instance} where location_id refers to a GCP region.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.