{ "mtlsRootUrl": "https://apim.mtls.googleapis.com/", "title": "API Management API", "kind": "discovery#restDescription", "batchPath": "batch", "ownerName": "Google", "name": "apim", "rootUrl": "https://apim.googleapis.com/", "ownerDomain": "google.com", "version_module": true, "protocol": "rest", "description": "Enables users to discover shadow APIs in existing Google Cloud infrastructure.", "version": "v1alpha", "canonicalName": "API Management", "basePath": "", "schemas": { "HttpOperationQueryParam": { "type": "object", "properties": { "name": { "description": "Name of query param", "type": "string" }, "dataType": { "enumDescriptions": [ "Unspecified data type", "Boolean data type", "Integer data type", "Float data type", "String data type", "UUID data type" ], "enum": [ "DATA_TYPE_UNSPECIFIED", "BOOL", "INTEGER", "FLOAT", "STRING", "UUID" ], "description": "Data type of path param", "type": "string" }, "count": { "format": "int64", "type": "string", "description": "The number of occurrences of this query parameter across transactions." } }, "id": "HttpOperationQueryParam", "description": "An aggregation of HTTP query parameter occurrences." }, "ObservationJob": { "properties": { "state": { "description": "Output only. The observation job state", "readOnly": true, "enumDescriptions": [ "Unspecified state", "Job is in the creating state", "Job is in the enabling state", "Job is enabled", "Job is in the disabling state", "Job is disabled", "Job is being deleted", "Job is in an error state" ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ENABLING", "ENABLED", "DISABLING", "DISABLED", "DELETING", "ERROR" ] }, "name": { "description": "Identifier. name of resource Format: projects/{project}/locations/{location}/observationJobs/{observation_job}", "type": "string" }, "sources": { "type": "array", "description": "Optional. These should be of the same kind of source.", "items": { "type": "string" } }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. [Output only] Update time stamp", "readOnly": true }, "createTime": { "description": "Output only. [Output only] Create time stamp", "readOnly": true, "format": "google-datetime", "type": "string" } }, "type": "object", "description": "Message describing ObservationJob object", "id": "ObservationJob" }, "TagAction": { "properties": { "action": { "enumDescriptions": [ "Unspecified.", "Addition of a Tag.", "Removal of a Tag." ], "enum": [ "ACTION_UNSPECIFIED", "ADD", "REMOVE" ], "description": "Required. Action to be applied", "type": "string" }, "tag": { "description": "Required. Tag to be added or removed", "type": "string" } }, "type": "object", "description": "Message for edit tag action", "id": "TagAction" }, "EditTagsApiObservationsRequest": { "description": "Message for requesting edit tags for ApiObservation", "id": "EditTagsApiObservationsRequest", "properties": { "tagActions": { "description": "Required. Tag actions to be applied", "items": { "$ref": "TagAction" }, "type": "array" }, "apiObservationId": { "type": "string", "description": "Required. Identifier of ApiObservation need to be edit tags Format example: \"apigee.googleapis.com|us-west1|443\"" } }, "type": "object" }, "BatchEditTagsApiObservationsRequest": { "description": "Message for requesting batch edit tags for ApiObservations", "id": "BatchEditTagsApiObservationsRequest", "properties": { "requests": { "description": "Required. The request message specifying the resources to update. A maximum of 1000 apiObservations can be modified in a batch.", "items": { "$ref": "EditTagsApiObservationsRequest" }, "type": "array" } }, "type": "object" }, "ListApiObservationsResponse": { "id": "ListApiObservationsResponse", "description": "Message for response to listing ApiObservations", "type": "object", "properties": { "apiObservations": { "type": "array", "description": "The ApiObservation from the specified project and location and ObservationJobs.", "items": { "$ref": "ApiObservation" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "ListLocationsResponse": { "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "Location" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "type": "object", "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse" }, "ApiObservation": { "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Create time stamp" }, "style": { "type": "string", "enumDescriptions": [ "Unknown style", "Style is Rest API", "Style is Grpc API", "Style is GraphQL API" ], "enum": [ "STYLE_UNSPECIFIED", "REST", "GRPC", "GRAPHQL" ], "description": "Style of ApiObservation" }, "serverIps": { "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: `\"192.168.1.1\"`, `\"10.0.0.1:80\"`, `\"FE80::0202:B3FF:FE1E:8329\"`.", "items": { "type": "string" }, "type": "array" }, "sourceLocations": { "description": "Location of the Observation Source, for example \"us-central1\" or \"europe-west1.\"", "items": { "type": "string" }, "type": "array" }, "tags": { "type": "array", "description": "User-defined tags to organize and sort", "items": { "type": "string" } }, "apiOperationCount": { "format": "int64", "type": "string", "description": "The number of observed API Operations." }, "updateTime": { "description": "Update time stamp", "format": "google-datetime", "type": "string" }, "lastEventDetectedTime": { "type": "string", "format": "google-datetime", "description": "Last event detected time stamp" }, "hostname": { "description": "The hostname of requests processed for this Observation.", "type": "string" }, "name": { "type": "string", "description": "Identifier. Name of resource" } }, "type": "object", "description": "Message describing ApiObservation object", "id": "ApiObservation" }, "ObservationSource": { "properties": { "createTime": { "description": "Output only. [Output only] Create time stamp", "readOnly": true, "format": "google-datetime", "type": "string" }, "state": { "description": "Output only. The observation source state", "readOnly": true, "enumDescriptions": [ "Unspecified state", "Source is in the creating state", "Source has been created and is ready to use", "Source is being deleted", "Source is in an error state" ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "CREATED", "DELETING", "ERROR" ] }, "name": { "type": "string", "description": "Identifier. name of resource For MVP, each region can only have 1 source." }, "gclbObservationSource": { "description": "The GCLB observation source", "$ref": "GclbObservationSource" }, "updateTime": { "description": "Output only. [Output only] Update time stamp", "readOnly": true, "format": "google-datetime", "type": "string" } }, "type": "object", "description": "Observation source configuration types", "id": "ObservationSource" }, "Entitlement": { "properties": { "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time of the entitlement creation.", "readOnly": true }, "billingProjectNumber": { "description": "Project number of associated billing project that has Apigee and Advanced API Security entitled.", "type": "string", "format": "int64" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time of the entitlement update.", "readOnly": true }, "name": { "type": "string", "description": "Identifier. The entitlement resource name `projects/{project}/locations/{location}/entitlement`" }, "apiObservationEntitled": { "description": "Whether API Observation is entitled.", "type": "boolean" } }, "type": "object", "description": "Entitlement stores data related to API Observation entitlement for a given project", "id": "Entitlement" }, "Status": { "type": "object", "properties": { "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "type": "array" }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" }, "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." } }, "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)." }, "ListOperationsResponse": { "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "Operation" }, "type": "array" }, "unreachable": { "type": "array", "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" } } }, "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations." }, "ListObservationJobsResponse": { "properties": { "observationJobs": { "type": "array", "description": "The ObservationJob from the specified project and location.", "items": { "$ref": "ObservationJob" } }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } } }, "type": "object", "description": "Message for response to listing ObservationJobs", "id": "ListObservationJobsResponse" }, "ApiOperation": { "properties": { "lastSeenTime": { "format": "google-datetime", "type": "string", "description": "Last seen time stamp" }, "httpOperation": { "description": "An HTTP Operation.", "$ref": "HttpOperation" }, "count": { "format": "int64", "type": "string", "description": "The number of occurrences of this API Operation." }, "name": { "description": "Identifier. Name of resource", "type": "string" }, "firstSeenTime": { "format": "google-datetime", "type": "string", "description": "First seen time stamp" } }, "type": "object", "description": "Message describing ApiOperation object", "id": "ApiOperation" }, "OperationMetadata": { "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation.", "type": "object", "properties": { "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "apiVersion": { "readOnly": true, "description": "Output only. API version used to start the operation.", "type": "string" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "endTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation finished running." }, "verb": { "type": "string", "readOnly": true, "description": "Output only. Name of the verb executed by the operation." }, "statusMessage": { "type": "string", "readOnly": true, "description": "Output only. Human-readable status of the operation, if any." }, "requestedCancellation": { "type": "boolean", "readOnly": true, "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`." } } }, "BatchEditTagsApiObservationsResponse": { "id": "BatchEditTagsApiObservationsResponse", "description": "Message for response to edit Tags for ApiObservations", "type": "object", "properties": { "apiObservations": { "description": "ApiObservations that were changed", "items": { "$ref": "ApiObservation" }, "type": "array" } } }, "GclbObservationSource": { "properties": { "pscNetworkConfigs": { "description": "Required. The VPC networks where traffic will be observed. All load balancers within this network will be observed. Currently, this is limited to only one network.", "items": { "$ref": "GclbObservationSourcePscNetworkConfig" }, "type": "array" } }, "type": "object", "description": "The GCLB observation source.", "id": "GclbObservationSource" }, "DisableObservationJobRequest": { "properties": {}, "type": "object", "description": "Message for disabling an ObservationJob", "id": "DisableObservationJobRequest" }, "HttpOperationPathParam": { "description": "HTTP Path parameter.", "id": "HttpOperationPathParam", "properties": { "position": { "type": "integer", "format": "int32", "description": "Segment location in the path, 1-indexed" }, "dataType": { "enumDescriptions": [ "Unspecified data type", "Boolean data type", "Integer data type", "Float data type", "String data type", "UUID data type" ], "enum": [ "DATA_TYPE_UNSPECIFIED", "BOOL", "INTEGER", "FLOAT", "STRING", "UUID" ], "description": "Data type of path param", "type": "string" } }, "type": "object" }, "ListApiOperationsResponse": { "properties": { "apiOperations": { "description": "The ApiOperations from the specified project and location and ObservationJob and ApiObservation.", "items": { "$ref": "ApiOperation" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "type": "object", "description": "Message for response to listing ApiOperations", "id": "ListApiOperationsResponse" }, "GclbObservationSourcePscNetworkConfig": { "id": "GclbObservationSourcePscNetworkConfig", "description": "Network information for setting up a PSC connection.", "type": "object", "properties": { "network": { "type": "string", "description": "Required. The VPC network. Format: `projects/{project_id}/global/networks/{network}`" }, "subnetwork": { "description": "Required. The subnetwork in the source region that will be used to connect to the Cloud Load Balancers via PSC NEGs. Must belong to `network`. Format: projects/{project_id}/regions/{region}/subnetworks/{subnet}", "type": "string" } } }, "EnableObservationJobRequest": { "properties": {}, "type": "object", "description": "Message for enabling an ObservationJob", "id": "EnableObservationJobRequest" }, "HttpOperationHeader": { "properties": { "dataType": { "type": "string", "enumDescriptions": [ "Unspecified data type", "Boolean data type", "Integer data type", "Float data type", "String data type", "UUID data type" ], "enum": [ "DATA_TYPE_UNSPECIFIED", "BOOL", "INTEGER", "FLOAT", "STRING", "UUID" ], "description": "Data type of header" }, "count": { "description": "The number of occurrences of this Header across transactions.", "format": "int64", "type": "string" }, "name": { "description": "Header name.", "type": "string" } }, "type": "object", "description": "An aggregation of HTTP header occurrences.", "id": "HttpOperationHeader" }, "Operation": { "type": "object", "properties": { "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object", "description": "The normal, successful response of the operation. 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`." }, "metadata": { "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.", "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "done": { "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.", "type": "boolean" }, "name": { "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}`.", "type": "string" } }, "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call." }, "CancelOperationRequest": { "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "type": "object", "properties": {} }, "HttpOperation": { "properties": { "path": { "type": "string", "description": "Path of the HTTP request." }, "pathParams": { "description": "Path params of HttpOperation", "items": { "$ref": "HttpOperationPathParam" }, "type": "array" }, "queryParams": { "description": "Query params of HttpOperation", "type": "object", "additionalProperties": { "$ref": "HttpOperationQueryParam" } }, "method": { "type": "string", "enumDescriptions": [ "Unspecified HTTP method", "GET HTTP method", "HEAD HTTP method", "POST HTTP method", "PUT HTTP method", "PATCH HTTP method", "DELETE HTTP method", "TRACE HTTP method", "OPTIONS HTTP method", "CONNECT HTTP method" ], "enum": [ "HTTP_METHOD_UNSPECIFIED", "GET", "HEAD", "POST", "PUT", "PATCH", "DELETE", "TRACE", "OPTIONS", "CONNECT" ], "description": "HTTP Method." }, "response": { "description": "Response metadata.", "$ref": "HttpOperationHttpResponse" }, "request": { "description": "Request metadata.", "$ref": "HttpOperationHttpRequest" } }, "type": "object", "description": "An HTTP-based API Operation, sometimes called a \"REST\" Operation.", "id": "HttpOperation" }, "ListObservationSourcesResponse": { "description": "Message for response to listing ObservationSources", "id": "ListObservationSourcesResponse", "properties": { "observationSources": { "type": "array", "description": "The ObservationSource from the specified project and location.", "items": { "$ref": "ObservationSource" } }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "unreachable": { "description": "Locations that could not be reached.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "HttpOperationHttpRequest": { "description": "An aggregation of HTTP requests.", "id": "HttpOperationHttpRequest", "properties": { "headers": { "description": "Unordered map from header name to header metadata", "additionalProperties": { "$ref": "HttpOperationHeader" }, "type": "object" } }, "type": "object" }, "ListApiObservationTagsResponse": { "description": "Message for response to listing tags", "id": "ListApiObservationTagsResponse", "properties": { "apiObservationTags": { "type": "array", "description": "The tags from the specified project", "items": { "type": "string" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, "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); }", "id": "Empty" }, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", "properties": { "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" }, "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" }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } } }, "type": "object" }, "HttpOperationHttpResponse": { "description": "An aggregation of HTTP responses.", "id": "HttpOperationHttpResponse", "properties": { "headers": { "description": "Unordered map from header name to header metadata", "type": "object", "additionalProperties": { "$ref": "HttpOperationHeader" } }, "responseCodes": { "description": "Map of status code to observed count", "type": "object", "additionalProperties": { "type": "string", "format": "int64" } } }, "type": "object" } }, "servicePath": "", "discoveryVersion": "v1", "baseUrl": "https://apim.googleapis.com/", "documentationLink": "https://cloud.google.com/apigee/", "id": "apim:v1alpha", "revision": "20260506", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "fullyEncodeReservedExpansion": true, "parameters": { "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "description": "Data format for response.", "type": "string", "default": "json", "enum": [ "json", "media", "proto" ] }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "enum": [ "1", "2" ] }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "key": { "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.", "location": "query", "type": "string" }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "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" } }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "resources": { "projects": { "resources": { "locations": { "methods": { "listApiObservationTags": { "id": "apim.projects.locations.listApiObservationTags", "description": "ListApiObservationTags lists all extant tags on any observation in the given project.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "description": "Optional. A page token, received from a previous `ListApiObservationTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservationTags` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location}", "location": "path" }, "pageSize": { "format": "int32", "type": "integer", "description": "Optional. The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 10 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query" } }, "path": "v1alpha/{+parent}:listApiObservationTags", "httpMethod": "GET", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:listApiObservationTags", "parameterOrder": [ "parent" ], "response": { "$ref": "ListApiObservationTagsResponse" } }, "getEntitlement": { "httpMethod": "GET", "path": "v1alpha/{+name}", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/entitlement$", "location": "path", "description": "Required. The entitlement resource name Format: projects/{project}/locations/{location}/entitlement" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "GetEntitlement returns the entitlement for the provided project.", "id": "apim.projects.locations.getEntitlement", "parameterOrder": [ "name" ], "response": { "$ref": "Entitlement" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/entitlement" }, "get": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}", "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "path": "v1alpha/{+name}", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Resource name for the location." } }, "httpMethod": "GET", "description": "Gets information about a location.", "id": "apim.projects.locations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "flatPath": "v1alpha/projects/{projectsId}/locations", "httpMethod": "GET", "parameters": { "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "format": "int32", "type": "integer" }, "pageToken": { "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string" }, "filter": { "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string" }, "extraLocationTypes": { "repeated": true, "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query" }, "name": { "description": "The resource that owns the locations collection, if applicable.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, "type": "string" } }, "path": "v1alpha/{+name}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "apim.projects.locations.list", "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version." } }, "resources": { "operations": { "methods": { "cancel": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "id": "apim.projects.locations.operations.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`.", "request": { "$ref": "CancelOperationRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "path": "v1alpha/{+name}:cancel", "httpMethod": "POST" }, "list": { "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "apim.projects.locations.operations.list", "httpMethod": "GET", "path": "v1alpha/{+name}/operations", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "The name of the operation's parent resource." }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "description": "The standard list page size.", "type": "integer", "format": "int32" } } }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "path": "v1alpha/{+name}", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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.", "id": "apim.projects.locations.operations.get" }, "delete": { "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "apim.projects.locations.operations.delete", "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`.", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1alpha/{+name}" } } }, "observationSources": { "methods": { "list": { "httpMethod": "GET", "path": "v1alpha/{+parent}/observationSources", "parameters": { "pageSize": { "description": "Optional. The maximum number of ObservationSources to return. The service may return fewer than this value. If unspecified, at most 10 ObservationSources will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "format": "int32", "type": "integer" }, "parent": { "location": "path", "description": "Required. The parent, which owns this collection of ObservationSources. Format: projects/{project}/locations/{location}", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. A page token, received from a previous `ListObservationSources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListObservationSources` must match the call that provided the page token." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "ListObservationSources gets all ObservationSources for a given project and location.", "id": "apim.projects.locations.observationSources.list", "parameterOrder": [ "parent" ], "response": { "$ref": "ListObservationSourcesResponse" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationSources" }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "ObservationSource" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationSources/{observationSourcesId}", "httpMethod": "GET", "path": "v1alpha/{+name}", "parameters": { "name": { "description": "Required. The name of the ObservationSource to retrieve. Format: projects/{project}/locations/{location}/observationSources/{source}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/observationSources/[^/]+$", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "GetObservationSource retrieves a single ObservationSource by name.", "id": "apim.projects.locations.observationSources.get" }, "create": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationSources", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "description": "CreateObservationSource creates a new ObservationSource but does not affect any deployed infrastructure. It is a configuration that can be used in an Observation Job to collect data about APIs running in user's dataplane.", "id": "apim.projects.locations.observationSources.create", "request": { "$ref": "ObservationSource" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+parent}/observationSources", "parameters": { "observationSourceId": { "type": "string", "location": "query", "description": "Required. The ID to use for the Observation Source. This value should be 4-63 characters, and valid characters are /a-z-/." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. Value for parent.", "location": "path" }, "requestId": { "type": "string", "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." } }, "httpMethod": "POST" }, "delete": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationSources/{observationSourcesId}", "httpMethod": "DELETE", "path": "v1alpha/{+name}", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/observationSources/[^/]+$", "location": "path", "description": "Required. Name of the resource Format: projects/{project}/locations/{location}/observationSources/{source}" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "DeleteObservationSource deletes an observation source. This method will fail if the observation source is currently being used by any ObservationJob, even if not enabled.", "id": "apim.projects.locations.observationSources.delete" } } }, "observationJobs": { "resources": { "apiObservations": { "resources": { "apiOperations": { "methods": { "get": { "description": "GetApiOperation retrieves a single ApiOperation by name.", "id": "apim.projects.locations.observationJobs.apiObservations.apiOperations.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+name}", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/observationJobs/[^/]+/apiObservations/[^/]+/apiOperations/[^/]+$", "location": "path", "description": "Required. The name of the ApiOperation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation}/apiOperation/{api_operation}" } }, "httpMethod": "GET", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}/apiOperations/{apiOperationsId}", "parameterOrder": [ "name" ], "response": { "$ref": "ApiOperation" } }, "list": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}/apiOperations", "parameterOrder": [ "parent" ], "response": { "$ref": "ListApiOperationsResponse" }, "parameters": { "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. The maximum number of ApiOperations to return. The service may return fewer than this value. If unspecified, at most 10 ApiOperations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000." }, "parent": { "description": "Required. The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/observationJobs/[^/]+/apiObservations/[^/]+$", "required": true, "type": "string" }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListApiApiOperations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiApiOperations` must match the call that provided the page token.", "type": "string" } }, "path": "v1alpha/{+parent}/apiOperations", "httpMethod": "GET", "id": "apim.projects.locations.observationJobs.apiObservations.apiOperations.list", "description": "ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } }, "methods": { "get": { "parameterOrder": [ "name" ], "response": { "$ref": "ApiObservation" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the ApiObservation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/observationJobs/[^/]+/apiObservations/[^/]+$", "required": true, "type": "string" } }, "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "apim.projects.locations.observationJobs.apiObservations.get", "description": "GetApiObservation retrieves a single ApiObservation by name." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.", "id": "apim.projects.locations.observationJobs.apiObservations.list", "httpMethod": "GET", "path": "v1alpha/{+parent}/apiObservations", "parameters": { "pageSize": { "description": "Optional. The maximum number of ApiObservations to return. The service may return fewer than this value. If unspecified, at most 10 ApiObservations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "format": "int32", "type": "integer" }, "pageToken": { "type": "string", "description": "Optional. A page token, received from a previous `ListApiObservations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservations` must match the call that provided the page token.", "location": "query" }, "parent": { "description": "Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/observationJobs/[^/]+$", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListApiObservationsResponse" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations" }, "batchEditTags": { "description": "BatchEditTagsApiObservations adds or removes Tags for ApiObservations.", "id": "apim.projects.locations.observationJobs.apiObservations.batchEditTags", "request": { "$ref": "BatchEditTagsApiObservationsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+parent}/apiObservations:batchEditTags", "parameters": { "parent": { "description": "Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/observationJobs/[^/]+$", "required": true, "type": "string" } }, "httpMethod": "POST", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations:batchEditTags", "parameterOrder": [ "parent" ], "response": { "$ref": "BatchEditTagsApiObservationsResponse" } } } } }, "methods": { "get": { "parameters": { "name": { "description": "Required. The name of the ObservationJob to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{job}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/observationJobs/[^/]+$", "required": true, "type": "string" } }, "path": "v1alpha/{+name}", "httpMethod": "GET", "id": "apim.projects.locations.observationJobs.get", "description": "GetObservationJob retrieves a single ObservationJob by name.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}", "parameterOrder": [ "name" ], "response": { "$ref": "ObservationJob" } }, "enable": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}:enable", "request": { "$ref": "EnableObservationJobRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "apim.projects.locations.observationJobs.enable", "description": "Enables the given ObservationJob.", "httpMethod": "POST", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/observationJobs/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the ObservationJob to enable. Format: projects/{project}/locations/{location}/observationJobs/{job}", "location": "path" } }, "path": "v1alpha/{+name}:enable" }, "disable": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}:disable", "request": { "$ref": "DisableObservationJobRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "apim.projects.locations.observationJobs.disable", "description": "Disables the given ObservationJob.", "httpMethod": "POST", "parameters": { "name": { "location": "path", "description": "Required. The name of the ObservationJob to disable. Format: projects/{project}/locations/{location}/observationJobs/{job}", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/observationJobs/[^/]+$" } }, "path": "v1alpha/{+name}:disable" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "apim.projects.locations.observationJobs.list", "description": "ListObservationJobs gets all ObservationJobs for a given project and location.", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent, which owns this collection of ObservationJobs. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListObservationJobs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListObservationJobs` must match the call that provided the page token.", "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "description": "Optional. The maximum number of ObservationJobs to return. The service may return fewer than this value. If unspecified, at most 10 ObservationJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query" } }, "path": "v1alpha/{+parent}/observationJobs", "parameterOrder": [ "parent" ], "response": { "$ref": "ListObservationJobsResponse" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs" }, "create": { "parameters": { "observationJobId": { "description": "Required. The ID to use for the Observation Job. This value should be 4-63 characters, and valid characters are /a-z-/.", "location": "query", "type": "string" }, "requestId": { "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. The parent resource where this ObservationJob will be created. Format: projects/{project}/locations/{location}", "location": "path" } }, "path": "v1alpha/{+parent}/observationJobs", "httpMethod": "POST", "id": "apim.projects.locations.observationJobs.create", "description": "CreateObservationJob creates a new ObservationJob but does not have any effecton its own. It is a configuration that can be used in an Observation Job to collect data about existing APIs.", "request": { "$ref": "ObservationJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" } }, "delete": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "DeleteObservationJob deletes an ObservationJob. This method will fail if the observation job is currently being used by any ObservationSource, even if not enabled.", "id": "apim.projects.locations.observationJobs.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+name}", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/observationJobs/[^/]+$", "location": "path", "description": "Required. Name of the resource Format: projects/{project}/locations/{location}/observationJobs/{observation_job}" } }, "httpMethod": "DELETE" } } } } } } } } }