API Reference google_api_memcache v0.19.0

Modules

API client metadata for GoogleApi.Memcache.V1.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.Memcache.V1.

The request message for Operations.CancelOperation.

Time window specified for daily operations.

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values A month and day value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp.

DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

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

Represents the metadata of a long-running operation.

Attributes

  • consumerDefinedName (type: String.t, default: nil) - consumer_defined_name is the name that is set by the consumer. On the other hand Name field represents system-assigned id of an instance so consumers are not necessarily aware of it. consumer_defined_name is used for notification/UI purposes for consumer to recognize their instances.
  • createTime (type: DateTime.t, default: nil) - Output only. Timestamp when the resource was created.
  • labels (type: map(), default: nil) - Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.
  • maintenancePolicyNames (type: map(), default: nil) - Deprecated. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.
  • maintenanceSchedules (type: %{optional(String.t) => GoogleApi.Memcache.V1.Model.GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule.t}, default: nil) - The MaintenanceSchedule contains the scheduling information of published maintenance schedule with same key as software_versions.
  • maintenanceSettings (type: GoogleApi.Memcache.V1.Model.GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings.t, default: nil) - Optional. The MaintenanceSettings associated with instance.
  • name (type: String.t, default: nil) - Unique name of the resource. It uses the form: projects/{project_id|project_number}/locations/{location_id}/instances/{instance_id} Note: Either project_id or project_number can be used, but keep it consistent with other APIs (e.g. RescheduleUpdate)
  • producerMetadata (type: map(), default: nil) - Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata.
  • provisionedResources (type: list(GoogleApi.Memcache.V1.Model.GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource.t), default: nil) - Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata.
  • slmInstanceTemplate (type: String.t, default: nil) - Link to the SLM instance template. Only populated when updating SLM instances via SSA's Actuation service adaptor. Service producers with custom control plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they should use software_versions.
  • sloMetadata (type: GoogleApi.Memcache.V1.Model.GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata.t, default: nil) - Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description.
  • softwareVersions (type: map(), default: nil) - Software versions that are used to deploy this instance. This can be mutated by rollout services.
  • state (type: String.t, default: nil) - Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).
  • tenantProjectId (type: String.t, default: nil) - Output only. ID of the associated GCP tenant project. See go/get-instance-metadata.
  • updateTime (type: DateTime.t, default: nil) - Output only. Timestamp when the resource was last modified.

Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule

Maintenance settings associated with instance. Allows service producers and end users to assign settings that controls maintenance on this instance.

Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information.

PerSliSloEligibility is a mapping from an SLI name to eligibility.

SloEligibility is a tuple containing eligibility value: true if an instance is eligible for SLO calculation or false if it should be excluded from all SLO-related calculations along with a user-defined reason.

SloMetadata contains resources required for proper SLO classification of the instance.

A Memorystore for Memcached instance

Attributes

  • code (type: String.t, default: nil) - A code that correspond to one type of user-facing message.
  • message (type: String.t, default: nil) - Message on memcached instance which will be exposed to users.

The response message for Locations.ListLocations.

The response message for Operations.ListOperations.

A resource that represents Google Cloud Platform location.

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

Defines policies to service maintenance events.

MaintenanceWindow definition.

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.

Attributes

  • host (type: String.t, default: nil) - Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
  • nodeId (type: String.t, default: nil) - Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
  • parameters (type: GoogleApi.Memcache.V1.Model.MemcacheParameters.t, default: nil) - User defined parameters currently applied to the node.
  • port (type: integer(), default: nil) - Output only. The port number of the Memcached server on this node.
  • state (type: String.t, default: nil) - Output only. Current state of the Memcached node.
  • zone (type: String.t, default: nil) - Output only. Location (GCP Zone) for the Memcached node.

Configuration for a Memcached Node.

This resource represents a long-running operation that is the result of a network API call.

Represents the metadata of a long-running operation.

Configure the schedule.

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

Maintenance policy applicable to instance updates.

Time window specified for weekly operations.

API client metadata for GoogleApi.Memcache.V1beta2.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.Memcache.V1beta2.

The request message for Operations.CancelOperation.

Time window specified for daily operations.

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values A month and day value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp.

DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

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

Represents the metadata of a long-running operation.

Attributes

  • consumerDefinedName (type: String.t, default: nil) - consumer_defined_name is the name that is set by the consumer. On the other hand Name field represents system-assigned id of an instance so consumers are not necessarily aware of it. consumer_defined_name is used for notification/UI purposes for consumer to recognize their instances.
  • createTime (type: DateTime.t, default: nil) - Output only. Timestamp when the resource was created.
  • labels (type: map(), default: nil) - Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.
  • maintenancePolicyNames (type: map(), default: nil) - Deprecated. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.
  • maintenanceSchedules (type: %{optional(String.t) => GoogleApi.Memcache.V1beta2.Model.GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule.t}, default: nil) - The MaintenanceSchedule contains the scheduling information of published maintenance schedule with same key as software_versions.
  • maintenanceSettings (type: GoogleApi.Memcache.V1beta2.Model.GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings.t, default: nil) - Optional. The MaintenanceSettings associated with instance.
  • name (type: String.t, default: nil) - Unique name of the resource. It uses the form: projects/{project_id|project_number}/locations/{location_id}/instances/{instance_id} Note: Either project_id or project_number can be used, but keep it consistent with other APIs (e.g. RescheduleUpdate)
  • producerMetadata (type: map(), default: nil) - Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata.
  • provisionedResources (type: list(GoogleApi.Memcache.V1beta2.Model.GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource.t), default: nil) - Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata.
  • slmInstanceTemplate (type: String.t, default: nil) - Link to the SLM instance template. Only populated when updating SLM instances via SSA's Actuation service adaptor. Service producers with custom control plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they should use software_versions.
  • sloMetadata (type: GoogleApi.Memcache.V1beta2.Model.GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata.t, default: nil) - Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description.
  • softwareVersions (type: map(), default: nil) - Software versions that are used to deploy this instance. This can be mutated by rollout services.
  • state (type: String.t, default: nil) - Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).
  • tenantProjectId (type: String.t, default: nil) - Output only. ID of the associated GCP tenant project. See go/get-instance-metadata.
  • updateTime (type: DateTime.t, default: nil) - Output only. Timestamp when the resource was last modified.

Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule

Maintenance settings associated with instance. Allows service producers and end users to assign settings that controls maintenance on this instance.

Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information.

PerSliSloEligibility is a mapping from an SLI name to eligibility.

SloEligibility is a tuple containing eligibility value: true if an instance is eligible for SLO calculation or false if it should be excluded from all SLO-related calculations along with a user-defined reason.

SloMetadata contains resources required for proper SLO classification of the instance.

A Memorystore for Memcached instance

Attributes

  • code (type: String.t, default: nil) - A code that correspond to one type of user-facing message.
  • message (type: String.t, default: nil) - Message on memcached instance which will be exposed to users.

The response message for Locations.ListLocations.

The response message for Operations.ListOperations.

A resource that represents Google Cloud Platform location.

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

Defines policies to service maintenance events.

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.

Attributes

  • host (type: String.t, default: nil) - Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
  • nodeId (type: String.t, default: nil) - Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
  • parameters (type: GoogleApi.Memcache.V1beta2.Model.MemcacheParameters.t, default: nil) - User defined parameters currently applied to the node.
  • port (type: integer(), default: nil) - Output only. The port number of the Memcached server on this node.
  • state (type: String.t, default: nil) - Output only. Current state of the Memcached node.
  • updateAvailable (type: boolean(), default: nil) - Output only. Returns true if there is an update waiting to be applied
  • zone (type: String.t, default: nil) - Output only. Location (GCP Zone) for the Memcached node.

Configuration for a Memcached Node.

This resource represents a long-running operation that is the result of a network API call.

Represents the metadata of a long-running operation.

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

Maintenance policy applicable to instance updates.

Time window specified for weekly operations.