blob: ee55f6eedd7463851b87291b9f72dd9019aa1579 [file] [log] [blame] [edit]
{
"schemas": {
"GoogleCloudSaasacceleratorManagementProvidersV1Instance": {
"properties": {
"slmInstanceTemplate": {
"type": "string",
"description": "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."
},
"name": {
"description": "Unique name of the resource. It uses the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}`",
"type": "string"
},
"consumerDefinedName": {
"type": "string",
"description": "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."
},
"producerMetadata": {
"description": "Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata.",
"additionalProperties": {
"type": "string"
},
"type": "object",
"readOnly": true
},
"provisionedResources": {
"readOnly": true,
"type": "array",
"items": {
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource"
},
"description": "Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata."
},
"sloMetadata": {
"description": "Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description.",
"readOnly": true,
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata"
},
"createTime": {
"description": "Output only. Timestamp when the resource was created.",
"readOnly": true,
"type": "string",
"format": "google-datetime"
},
"state": {
"enumDescriptions": [
"Unspecified state.",
"Instance is being created.",
"Instance has been created and is ready to use.",
"Instance is being updated.",
"Instance is unheathy and under repair.",
"Instance is being deleted.",
"Instance encountered an error and is in indeterministic state."
],
"type": "string",
"description": "Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).",
"readOnly": true,
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"READY",
"UPDATING",
"REPAIRING",
"DELETING",
"ERROR"
]
},
"maintenanceSettings": {
"description": "Optional. The MaintenanceSettings associated with instance.",
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings"
},
"softwareVersions": {
"type": "object",
"description": "Software versions that are used to deploy this instance. This can be mutated by rollout services.",
"additionalProperties": {
"type": "string"
}
},
"labels": {
"description": "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.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"maintenancePolicyNames": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "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."
},
"tenantProjectId": {
"readOnly": true,
"description": "Output only. ID of the associated GCP tenant project. See go/get-instance-metadata.",
"type": "string"
},
"updateTime": {
"type": "string",
"readOnly": true,
"description": "Output only. Timestamp when the resource was last modified.",
"format": "google-datetime"
},
"maintenanceSchedules": {
"type": "object",
"additionalProperties": {
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule"
},
"description": "The MaintenanceSchedule contains the scheduling information of published maintenance schedule with same key as software_versions."
}
},
"id": "GoogleCloudSaasacceleratorManagementProvidersV1Instance",
"type": "object"
},
"UpdateParametersRequest": {
"properties": {
"parameters": {
"$ref": "MemcacheParameters",
"description": "The parameters to apply to the instance."
},
"updateMask": {
"type": "string",
"description": "Required. Mask of fields to update.",
"format": "google-fieldmask"
}
},
"type": "object",
"id": "UpdateParametersRequest",
"description": "Request for UpdateParameters."
},
"GoogleCloudMemcacheV1beta2OperationMetadata": {
"id": "GoogleCloudMemcacheV1beta2OperationMetadata",
"type": "object",
"description": "Represents the metadata of a long-running operation.",
"properties": {
"cancelRequested": {
"type": "boolean",
"readOnly": true,
"description": "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 of 1, corresponding to `Code.CANCELLED`."
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"type": "string",
"readOnly": true
},
"endTime": {
"description": "Output only. Time when the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"createTime": {
"readOnly": true,
"format": "google-datetime",
"description": "Output only. Time when the operation was created.",
"type": "string"
},
"apiVersion": {
"readOnly": true,
"description": "Output only. API version used to start the operation.",
"type": "string"
},
"target": {
"readOnly": true,
"type": "string",
"description": "Output only. Server-defined resource path for the target of the operation."
},
"statusDetail": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
}
}
},
"Location": {
"properties": {
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"labels": {
"type": "object",
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
"additionalProperties": {
"type": "string"
}
},
"metadata": {
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"description": "Service-specific metadata. For example the available capacity at the given location.",
"type": "object"
},
"name": {
"type": "string",
"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`"
},
"displayName": {
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
"type": "string"
}
},
"id": "Location",
"description": "A resource that represents Google Cloud Platform location.",
"type": "object"
},
"GoogleCloudMemcacheV1beta2LocationMetadata": {
"properties": {
"availableZones": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"$ref": "ZoneMetadata"
},
"description": "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."
}
},
"type": "object",
"id": "GoogleCloudMemcacheV1beta2LocationMetadata",
"description": "Metadata for the given google.cloud.location.Location."
},
"MaintenancePolicy": {
"description": "Defines policies to service maintenance events.",
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "Optional. The state of the policy.",
"enumDescriptions": [
"Unspecified state.",
"Resource is ready to be used.",
"Resource is being deleted. It can no longer be attached to instances."
],
"enum": [
"STATE_UNSPECIFIED",
"READY",
"DELETING"
]
},
"name": {
"type": "string",
"description": "Required. MaintenancePolicy name using the form: `projects/{project_id}/locations/{location_id}/maintenancePolicies/{maintenance_policy_id}` where {project_id} refers to a GCP consumer project ID, {location_id} refers to a GCP region/zone, {maintenance_policy_id} must be 1-63 characters long and match the regular expression `[a-z0-9]([-a-z0-9]*[a-z0-9])?`."
},
"updateTime": {
"type": "string",
"description": "Output only. The time when the resource was updated.",
"format": "google-datetime"
},
"description": {
"description": "Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.",
"type": "string"
},
"labels": {
"description": "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.",
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"createTime": {
"format": "google-datetime",
"description": "Output only. The time when the resource was created.",
"type": "string"
},
"updatePolicy": {
"description": "Maintenance policy applicable to instance update.",
"$ref": "UpdatePolicy"
}
},
"id": "MaintenancePolicy"
},
"GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata": {
"id": "GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata",
"properties": {
"nodeId": {
"description": "The id of the node. This should be equal to SaasInstanceNode.node_id.",
"type": "string"
},
"location": {
"type": "string",
"description": "The location of the node, if different from instance location."
},
"exclusions": {
"items": {
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion"
},
"type": "array",
"description": "By default node is eligible if instance is eligible. But individual node might be excluded from SLO by adding entry here. For semantic see SloMetadata.exclusions. If both instance and node level exclusions are present for time period, the node level's reason will be reported by Eligibility Exporter."
}
},
"type": "object",
"description": "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."
},
"InstanceMessage": {
"properties": {
"message": {
"type": "string",
"description": "Message on memcached instance which will be exposed to users."
},
"code": {
"enumDescriptions": [
"Message Code not set.",
"Memcached nodes are distributed unevenly."
],
"enum": [
"CODE_UNSPECIFIED",
"ZONE_DISTRIBUTION_UNBALANCED"
],
"description": "A code that correspond to one type of user-facing message.",
"type": "string"
}
},
"id": "InstanceMessage",
"type": "object"
},
"ZoneMetadata": {
"id": "ZoneMetadata",
"properties": {},
"type": "object"
},
"MaintenanceWindow": {
"id": "MaintenanceWindow",
"properties": {
"dailyCycle": {
"$ref": "DailyCycle",
"description": "Daily cycle."
},
"weeklyCycle": {
"$ref": "WeeklyCycle",
"description": "Weekly cycle."
}
},
"type": "object",
"description": "MaintenanceWindow definition."
},
"MemcacheParameters": {
"type": "object",
"id": "MemcacheParameters",
"properties": {
"params": {
"additionalProperties": {
"type": "string"
},
"description": "User defined set of parameters to use in the memcached process.",
"type": "object"
},
"id": {
"description": "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 and any action needs to be taken to apply parameters on nodes.",
"readOnly": true,
"type": "string"
}
}
},
"GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility": {
"type": "object",
"description": "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.",
"properties": {
"reason": {
"description": "User-defined reason for the current value of instance eligibility. Usually, this can be directly mapped to the internal state. An empty reason is allowed.",
"type": "string"
},
"eligible": {
"type": "boolean",
"description": "Whether an instance is eligible or ineligible."
}
},
"id": "GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility"
},
"Date": {
"type": "object",
"description": "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`.",
"id": "Date",
"properties": {
"month": {
"type": "integer",
"format": "int32",
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day."
},
"day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32",
"type": "integer"
},
"year": {
"format": "int32",
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"type": "integer"
}
}
},
"Status": {
"id": "Status",
"description": "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](https://github.com/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](https://cloud.google.com/apis/design/errors).",
"properties": {
"details": {
"items": {
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"type": "object"
},
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"type": "array"
},
"message": {
"type": "string",
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client."
},
"code": {
"type": "integer",
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code."
}
},
"type": "object"
},
"GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule": {
"description": "Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule",
"id": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule",
"type": "object",
"properties": {
"endTime": {
"type": "string",
"format": "google-datetime",
"description": "The scheduled end time for the maintenance."
},
"startTime": {
"format": "google-datetime",
"description": "The scheduled start time for the maintenance.",
"type": "string"
},
"canReschedule": {
"description": "Can this scheduled update be rescheduled? By default, it's true and API needs to do explicitly check whether it's set, if it's set as false explicitly, it's false",
"type": "boolean"
},
"rolloutManagementPolicy": {
"type": "string",
"description": "The rollout management policy this maintenance schedule is associated with. When doing reschedule update request, the reschedule should be against this given policy."
}
}
},
"DailyCycle": {
"description": "Time window specified for daily operations.",
"type": "object",
"properties": {
"startTime": {
"description": "Time within the day to start the operations.",
"$ref": "TimeOfDay"
},
"duration": {
"description": "Output only. Duration of the time window, set by service producer.",
"type": "string",
"format": "google-duration"
}
},
"id": "DailyCycle"
},
"WeeklyCycle": {
"description": "Time window specified for weekly operations.",
"type": "object",
"id": "WeeklyCycle",
"properties": {
"schedule": {
"description": "User can specify multiple windows in a week. Minimum of 1 window.",
"items": {
"$ref": "Schedule"
},
"type": "array"
}
}
},
"GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource": {
"type": "object",
"id": "GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource",
"description": "Describes provisioned dataplane resources.",
"properties": {
"resourceUrl": {
"description": "URL identifying the resource, e.g. \"https://www.googleapis.com/compute/v1/projects/...)\".",
"type": "string"
},
"resourceType": {
"description": "Type of the resource. This can be either a GCP resource or a custom one (e.g. another cloud provider's VM). For GCP compute resources use singular form of the names listed in GCP compute API documentation (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: 'compute-instance', 'compute-disk', 'compute-autoscaler'.",
"type": "string"
}
}
},
"UpdatePolicy": {
"properties": {
"denyMaintenancePeriods": {
"items": {
"$ref": "DenyMaintenancePeriod"
},
"description": "Deny Maintenance Period that is applied to resource to indicate when maintenance is forbidden. User can specify zero or more non-overlapping deny periods. For V1, Maximum number of deny_maintenance_periods is expected to be one.",
"type": "array"
},
"channel": {
"enumDescriptions": [
"Unspecified channel.",
"Early channel within a customer project.",
"Later channel within a customer project."
],
"type": "string",
"enum": [
"UPDATE_CHANNEL_UNSPECIFIED",
"EARLIER",
"LATER"
],
"description": "Optional. Relative scheduling channel applied to resource."
},
"window": {
"$ref": "MaintenanceWindow",
"description": "Optional. Maintenance window that is applied to resources covered by this policy."
}
},
"id": "UpdatePolicy",
"description": "Maintenance policy applicable to instance updates.",
"type": "object"
},
"CancelOperationRequest": {
"type": "object",
"properties": {},
"description": "The request message for Operations.CancelOperation.",
"id": "CancelOperationRequest"
},
"ListLocationsResponse": {
"type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"locations": {
"items": {
"$ref": "Location"
},
"description": "A list of locations that matches the specified filter in the request.",
"type": "array"
}
},
"id": "ListLocationsResponse",
"description": "The response message for Locations.ListLocations."
},
"DenyMaintenancePeriod": {
"type": "object",
"id": "DenyMaintenancePeriod",
"description": "DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.",
"properties": {
"time": {
"$ref": "TimeOfDay",
"description": "Time in UTC when the Blackout period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC"
},
"startDate": {
"$ref": "Date",
"description": "Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be the same or after the start."
},
"endDate": {
"$ref": "Date",
"description": "Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be before the end."
}
}
},
"Node": {
"properties": {
"state": {
"description": "Output only. Current state of the Memcached node.",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"READY",
"DELETING",
"UPDATING"
],
"enumDescriptions": [
"Node state is not set.",
"Node is being created.",
"Node has been created and ready to be used.",
"Node is being deleted.",
"Node is being updated."
],
"type": "string",
"readOnly": true
},
"nodeId": {
"description": "Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.",
"readOnly": true,
"type": "string"
},
"port": {
"readOnly": true,
"type": "integer",
"format": "int32",
"description": "Output only. The port number of the Memcached server on this node."
},
"zone": {
"type": "string",
"readOnly": true,
"description": "Output only. Location (GCP Zone) for the Memcached node."
},
"parameters": {
"$ref": "MemcacheParameters",
"description": "User defined parameters currently applied to the node."
},
"host": {
"readOnly": true,
"description": "Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.",
"type": "string"
}
},
"id": "Node",
"type": "object"
},
"Operation": {
"type": "object",
"id": "Operation",
"properties": {
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"name": {
"type": "string",
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`."
},
"done": {
"type": "boolean",
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available."
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any."
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
"type": "object"
}
},
"description": "This resource represents a long-running operation that is the result of a network API call."
},
"Empty": {
"id": "Empty",
"properties": {},
"type": "object",
"description": "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 `{}`."
},
"Instance": {
"type": "object",
"properties": {
"nodeConfig": {
"$ref": "NodeConfig",
"description": "Required. Configuration for Memcached nodes."
},
"updateTime": {
"readOnly": true,
"type": "string",
"description": "Output only. The time the instance was updated.",
"format": "google-datetime"
},
"name": {
"type": "string",
"description": "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 regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details."
},
"memcacheFullVersion": {
"description": "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\".",
"type": "string",
"readOnly": true
},
"parameters": {
"description": "Optional: User defined parameters to apply to the memcached process on each node.",
"$ref": "MemcacheParameters"
},
"instanceMessages": {
"type": "array",
"items": {
"$ref": "InstanceMessage"
},
"description": "List of messages that describe current statuses of memcached instance."
},
"memcacheVersion": {
"type": "string",
"enumDescriptions": [
"",
"Memcached 1.5 version."
],
"description": "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.",
"enum": [
"MEMCACHE_VERSION_UNSPECIFIED",
"MEMCACHE_1_5"
]
},
"memcacheNodes": {
"items": {
"$ref": "Node"
},
"description": "Output only. List of Memcached nodes. Refer to [Node] message for more details.",
"type": "array",
"readOnly": true
},
"displayName": {
"type": "string",
"description": "User provided name for the instance only used for display purposes. Cannot be more than 80 characters."
},
"zones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Zones where Memcached nodes should be provisioned in. 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."
},
"nodeCount": {
"description": "Required. Number of nodes in the Memcached instance.",
"format": "int32",
"type": "integer"
},
"labels": {
"description": "Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"state": {
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"READY",
"DELETING",
"PERFORMING_MAINTENANCE"
],
"description": "Output only. The state of this Memcached instance.",
"enumDescriptions": [
"State not set.",
"Memcached instance is being created.",
"Memcached instance has been created and ready to be used.",
"Memcached instance is being deleted.",
"Memcached instance is going through maintenance, e.g. data plane rollout."
],
"readOnly": true,
"type": "string"
},
"discoveryEndpoint": {
"readOnly": true,
"description": "Output only. Endpoint for Discovery API",
"type": "string"
},
"authorizedNetwork": {
"type": "string",
"description": "The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used."
},
"createTime": {
"format": "google-datetime",
"readOnly": true,
"type": "string",
"description": "Output only. The time the instance was created."
}
},
"id": "Instance"
},
"GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion": {
"properties": {
"reason": {
"type": "string",
"description": "Human-readable reason for the exclusion. This should be a static string (e.g. \"Disruptive update in progress\") and should not contain dynamically generated data (e.g. instance name). Can be left empty."
},
"startTime": {
"description": "Start time of the exclusion. No alignment (e.g. to a full minute) needed.",
"type": "string",
"format": "google-datetime"
},
"duration": {
"type": "string",
"format": "google-duration",
"description": "Exclusion duration. No restrictions on the possible values. When an ongoing operation is taking longer than initially expected, an existing entry in the exclusion list can be updated by extending the duration. This is supported by the subsystem exporting eligibility data as long as such extension is committed at least 10 minutes before the original exclusion expiration - otherwise it is possible that there will be \"gaps\" in the exclusion application in the exported timeseries."
},
"sliName": {
"description": "Name of an SLI that this exclusion applies to. Can be left empty, signaling that the instance should be excluded from all SLIs defined in the service SLO configuration.",
"type": "string"
}
},
"type": "object",
"id": "GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion",
"description": "SloExclusion represents an exclusion in SLI calculation applies to all SLOs."
},
"GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings": {
"id": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings",
"properties": {
"maintenancePolicies": {
"additionalProperties": {
"$ref": "MaintenancePolicy"
},
"description": "Optional. 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 embedded policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. If only the name is needed (like in the deprecated Instance.maintenance_policy_names field) then only populate MaintenancePolicy.name.",
"type": "object"
},
"exclude": {
"type": "boolean",
"description": "Optional. Exclude instance from maintenance. When true, rollout service will not attempt maintenance on the instance. Rollout service will include the instance in reported rollout progress as not attempted."
}
},
"type": "object",
"description": "Maintenance settings associated with instance. Allows service producers and end users to assign settings that controls maintenance on this instance."
},
"NodeConfig": {
"type": "object",
"id": "NodeConfig",
"description": "Configuration for a Memcached Node.",
"properties": {
"cpuCount": {
"description": "Required. Number of cpus per Memcached node.",
"format": "int32",
"type": "integer"
},
"memorySizeMb": {
"type": "integer",
"format": "int32",
"description": "Required. Memory size in MiB for each Memcached node."
}
}
},
"GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata": {
"type": "object",
"properties": {
"nodes": {
"type": "array",
"description": "Optional. List of nodes. Some producers need to use per-node metadata to calculate SLO. This field allows such producers to publish per-node SLO meta data, which will be consumed by SSA Eligibility Exporter and published in the form of per node metric to Monarch.",
"items": {
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata"
}
},
"tier": {
"type": "string",
"description": "Name of the SLO tier the Instance belongs to. This name will be expected to match the tiers specified in the service SLO configuration. Field is mandatory and must not be empty."
},
"eligibility": {
"description": "Optional. User-defined instance eligibility.",
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility"
},
"exclusions": {
"items": {
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion"
},
"type": "array",
"description": "List of SLO exclusion windows. When multiple entries in the list match (matching the exclusion time-window against current time point) the exclusion reason used in the first matching entry will be published. It is not needed to include expired exclusion in this list, as only the currently applicable exclusions are taken into account by the eligibility exporting subsystem (the historical state of exclusions will be reflected in the historically produced timeseries regardless of the current state). This field can be used to mark the instance as temporary ineligible for the purpose of SLO calculation. For permanent instance SLO exclusion, use of custom instance eligibility is recommended. See 'eligibility' field below."
}
},
"id": "GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata",
"description": "SloMetadata contains resources required for proper SLO classification of the instance."
},
"ListInstancesResponse": {
"description": "Response for ListInstances.",
"properties": {
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"resources": {
"items": {
"$ref": "Instance"
},
"description": "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.",
"type": "array"
}
},
"id": "ListInstancesResponse",
"type": "object"
},
"ApplyParametersRequest": {
"properties": {
"nodeIds": {
"items": {
"type": "string"
},
"description": "Nodes to which we should apply the instance-level parameter group.",
"type": "array"
},
"applyAll": {
"type": "boolean",
"description": "Whether to apply instance-level parameter group to all nodes. If set to true, will explicitly restrict users from specifying any nodes, and apply parameter group updates to all nodes within the instance."
}
},
"id": "ApplyParametersRequest",
"description": "Request for ApplyParameters.",
"type": "object"
},
"Schedule": {
"id": "Schedule",
"type": "object",
"properties": {
"day": {
"description": "Allows to define schedule that runs specified day of the week.",
"enumDescriptions": [
"The day of the week is unspecified.",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"type": "string",
"enum": [
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
},
"duration": {
"format": "google-duration",
"type": "string",
"description": "Output only. Duration of the time window, set by service producer."
},
"startTime": {
"$ref": "TimeOfDay",
"description": "Time within the window to start the operations."
}
},
"description": "Configure the schedule."
},
"TimeOfDay": {
"description": "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`.",
"properties": {
"minutes": {
"description": "Minutes of hour of day. Must be from 0 to 59.",
"format": "int32",
"type": "integer"
},
"nanos": {
"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
"format": "int32",
"type": "integer"
},
"hours": {
"format": "int32",
"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
"type": "integer"
},
"seconds": {
"format": "int32",
"type": "integer",
"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds."
}
},
"type": "object",
"id": "TimeOfDay"
},
"ListOperationsResponse": {
"properties": {
"operations": {
"type": "array",
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
}
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"description": "The response message for Operations.ListOperations.",
"type": "object",
"id": "ListOperationsResponse"
}
},
"name": "memcache",
"canonicalName": "Cloud Memorystore for Memcached",
"ownerDomain": "google.com",
"ownerName": "Google",
"kind": "discovery#restDescription",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"rootUrl": "https://memcache.googleapis.com/",
"baseUrl": "https://memcache.googleapis.com/",
"basePath": "",
"servicePath": "",
"title": "Cloud Memorystore for Memcached API",
"discoveryVersion": "v1",
"revision": "20201109",
"description": "Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP.",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "memcache:v1beta2",
"mtlsRootUrl": "https://memcache.mtls.googleapis.com/",
"protocol": "rest",
"version_module": true,
"batchPath": "batch",
"version": "v1beta2",
"resources": {
"projects": {
"resources": {
"locations": {
"resources": {
"instances": {
"methods": {
"applyParameters": {
"path": "v1beta2/{+name}:applyParameters",
"response": {
"$ref": "Operation"
},
"description": "ApplyParameters will restart the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.",
"parameters": {
"name": {
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"location": "path",
"type": "string",
"description": "Required. Resource name of the Memcached instance for which parameter group updates should be applied."
}
},
"request": {
"$ref": "ApplyParametersRequest"
},
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:applyParameters",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "memcache.projects.locations.instances.applyParameters",
"parameterOrder": [
"name"
]
},
"updateParameters": {
"path": "v1beta2/{+name}:updateParameters",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "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.",
"parameterOrder": [
"name"
],
"request": {
"$ref": "UpdateParametersRequest"
},
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:updateParameters",
"id": "memcache.projects.locations.instances.updateParameters",
"httpMethod": "PATCH",
"parameters": {
"name": {
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"description": "Required. Resource name of the Memcached instance for which the parameters should be updated.",
"required": true,
"type": "string"
}
}
},
"patch": {
"id": "memcache.projects.locations.instances.patch",
"path": "v1beta2/{+name}",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"type": "string",
"required": true,
"description": "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 regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details.",
"location": "path"
},
"updateMask": {
"type": "string",
"location": "query",
"description": "Required. Mask of fields to update. * `displayName`",
"format": "google-fieldmask"
}
},
"description": "Updates an existing Instance in a given project and location.",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"request": {
"$ref": "Instance"
},
"httpMethod": "PATCH"
},
"create": {
"parameters": {
"parent": {
"required": true,
"type": "string",
"description": "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",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$"
},
"instanceId": {
"location": "query",
"type": "string",
"description": "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, will raise an invalid argument error."
}
},
"description": "Creates a new Instance in a given location.",
"parameterOrder": [
"parent"
],
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/instances",
"id": "memcache.projects.locations.instances.create",
"path": "v1beta2/{+parent}/instances",
"request": {
"$ref": "Instance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "POST"
},
"delete": {
"response": {
"$ref": "Operation"
},
"description": "Deletes a single Instance.",
"path": "v1beta2/{+name}",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}",
"parameters": {
"name": {
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"description": "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",
"location": "path",
"required": true
}
},
"id": "memcache.projects.locations.instances.delete",
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"name"
]
},
"get": {
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "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",
"type": "string",
"location": "path",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "GET",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}",
"path": "v1beta2/{+name}",
"description": "Gets details of a single Instance.",
"response": {
"$ref": "Instance"
},
"id": "memcache.projects.locations.instances.get"
},
"list": {
"response": {
"$ref": "ListInstancesResponse"
},
"id": "memcache.projects.locations.instances.list",
"httpMethod": "GET",
"parameters": {
"orderBy": {
"location": "query",
"type": "string",
"description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted)."
},
"filter": {
"description": "List filter. For example, exclude all Memcached instances with name as my-instance by specifying \"name != my-instance\".",
"type": "string",
"location": "query"
},
"pageSize": {
"type": "integer",
"format": "int32",
"description": "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 to determine if there are more instances left to be queried.",
"location": "query"
},
"parent": {
"description": "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",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
"required": true,
"type": "string"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "The next_page_token value returned from a previous List request, if any."
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"parent"
],
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/instances",
"path": "v1beta2/{+parent}/instances",
"description": "Lists Instances in a given location."
}
}
},
"operations": {
"methods": {
"delete": {
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"type": "string",
"required": true,
"description": "The name of the operation resource to be deleted.",
"location": "path"
}
},
"response": {
"$ref": "Empty"
},
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"parameterOrder": [
"name"
],
"path": "v1beta2/{+name}",
"description": "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`.",
"id": "memcache.projects.locations.operations.delete"
},
"get": {
"parameters": {
"name": {
"type": "string",
"location": "path",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"description": "The name of the operation resource."
}
},
"parameterOrder": [
"name"
],
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"response": {
"$ref": "Operation"
},
"path": "v1beta2/{+name}",
"description": "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.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "memcache.projects.locations.operations.get",
"httpMethod": "GET"
},
"cancel": {
"id": "memcache.projects.locations.operations.cancel",
"httpMethod": "POST",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"path": "v1beta2/{+name}:cancel",
"description": "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`.",
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"required": true,
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"type": "string"
}
},
"response": {
"$ref": "Empty"
},
"request": {
"$ref": "CancelOperationRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"name"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/operations",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1beta2/{+name}/operations",
"response": {
"$ref": "ListOperationsResponse"
},
"httpMethod": "GET",
"id": "memcache.projects.locations.operations.list",
"parameters": {
"pageToken": {
"location": "query",
"type": "string",
"description": "The standard list page token."
},
"filter": {
"description": "The standard list filter.",
"type": "string",
"location": "query"
},
"pageSize": {
"description": "The standard list page size.",
"location": "query",
"format": "int32",
"type": "integer"
},
"name": {
"type": "string",
"required": true,
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"description": "The name of the operation's parent resource."
}
}
}
}
}
},
"methods": {
"list": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "ListLocationsResponse"
},
"id": "memcache.projects.locations.list",
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"type": "string",
"description": "The resource that owns the locations collection, if applicable.",
"pattern": "^projects/[^/]+$",
"location": "path",
"required": true
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"filter": {
"description": "The standard list filter.",
"type": "string",
"location": "query"
},
"pageToken": {
"description": "The standard list page token.",
"type": "string",
"location": "query"
}
},
"flatPath": "v1beta2/projects/{projectsId}/locations",
"description": "Lists information about the supported locations for this service.",
"path": "v1beta2/{+name}/locations"
},
"get": {
"description": "Gets information about a location.",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
"description": "Resource name for the location.",
"required": true
}
},
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}",
"id": "memcache.projects.locations.get",
"response": {
"$ref": "Location"
},
"path": "v1beta2/{+name}"
}
}
}
}
}
},
"parameters": {
"uploadType": {
"type": "string",
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"$.xgafv": {
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"enum": [
"1",
"2"
],
"location": "query",
"description": "V1 error format."
},
"fields": {
"type": "string",
"location": "query",
"description": "Selector specifying which fields to include in a partial response."
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"callback": {
"location": "query",
"type": "string",
"description": "JSONP"
},
"prettyPrint": {
"type": "boolean",
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query"
},
"alt": {
"default": "json",
"type": "string",
"enum": [
"json",
"media",
"proto"
],
"location": "query",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"description": "Data format for response."
},
"key": {
"location": "query",
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"quotaUser": {
"type": "string",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query"
}
},
"documentationLink": "https://cloud.google.com/memorystore/"
}