1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudMemorystoreforMemcached
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsInstances

ProjectsLocationsInstances

class ProjectsLocationsInstances extends Resource (View source)

The "instances" collection of methods.

Typical usage is:

 $memcacheService = new Google\Service\CloudMemorystoreforMemcached(...);
 $instances = $memcacheService->projects_locations_instances;

Methods

Operation
applyParameters(string $name, ApplyParametersRequest $postBody, array $optParams = [])

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

Operation
create(string $parent, Instance $postBody, array $optParams = [])

Creates a new Instance in a given location. (instances.create)

Operation
delete(string $name, array $optParams = [])

Deletes a single Instance. (instances.delete)

Instance
get(string $name, array $optParams = [])

Gets details of a single Instance. (instances.get)

ListInstancesResponse
listProjectsLocationsInstances(string $parent, array $optParams = [])

Lists Instances in a given location.

Operation
patch(string $name, Instance $postBody, array $optParams = [])

Updates an existing Instance in a given project and location.

Operation
rescheduleMaintenance(string $instance, RescheduleMaintenanceRequest $postBody, array $optParams = [])

Reschedules upcoming maintenance event. (instances.rescheduleMaintenance)

Operation
updateParameters(string $name, UpdateParametersRequest $postBody, array $optParams = [])

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.

Operation
upgrade(string $name, GoogleCloudMemcacheV1UpgradeInstanceRequest $postBody, array $optParams = [])

Upgrades the Memcache instance to a newer memcached engine version specified in the request. (instances.upgrade)

Details

at line 50
Operation applyParameters(string $name, ApplyParametersRequest $postBody, array $optParams = [])

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

(instances.applyParameters)

Parameters

string $name

Required. Resource name of the Memcached instance for which parameter group updates should be applied.
ApplyParametersRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 74
Operation create(string $parent, Instance $postBody, array $optParams = [])

Creates a new Instance in a given location. (instances.create)

Parameters

string $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
Instance $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 90
Operation delete(string $name, array $optParams = [])

Deletes a single Instance. (instances.delete)

Parameters

string $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
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 106
Instance get(string $name, array $optParams = [])

Gets details of a single Instance. (instances.get)

Parameters

string $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
array $optParams

Optional parameters.

Return Value

Instance

Exceptions

Exception

at line 135
ListInstancesResponse listProjectsLocationsInstances(string $parent, array $optParams = [])

Lists Instances in a given location.

(instances.listProjectsLocationsInstances)

Parameters

string $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
array $optParams

Optional parameters.

Return Value

ListInstancesResponse

Exceptions

Exception

at line 160
Operation patch(string $name, Instance $postBody, array $optParams = [])

Updates an existing Instance in a given project and location.

(instances.patch)

Parameters

string $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.
Instance $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 177
Operation rescheduleMaintenance(string $instance, RescheduleMaintenanceRequest $postBody, array $optParams = [])

Reschedules upcoming maintenance event. (instances.rescheduleMaintenance)

Parameters

string $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.
RescheduleMaintenanceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 196
Operation updateParameters(string $name, UpdateParametersRequest $postBody, array $optParams = [])

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.

(instances.updateParameters)

Parameters

string $name

Required. Resource name of the Memcached instance for which the parameters should be updated.
UpdateParametersRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 214
Operation upgrade(string $name, GoogleCloudMemcacheV1UpgradeInstanceRequest $postBody, array $optParams = [])

Upgrades the Memcache instance to a newer memcached engine version specified in the request. (instances.upgrade)

Parameters

string $name

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

Optional parameters.

Return Value

Operation

Exceptions

Exception