# Package google.cloud.apim.v1alpha

## Index

- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ApiDiscoveryObservation` (interface)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ApiDiscoveryOperationMetadata` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ApiObservation` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ApiObservation.Style` (enum)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ApiOperation` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.BatchEditTagsApiObservationsRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.BatchEditTagsApiObservationsResponse` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.CreateObservationJobRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.CreateObservationSourceRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.DataType` (enum)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.DeleteObservationJobRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.DeleteObservationSourceRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.DisableObservationJobRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.EditTagsApiObservationsRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.EnableObservationJobRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.GclbObservationSource` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.GclbObservationSource.PscNetworkConfig` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.GetApiObservationRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.GetApiOperationRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.GetObservationJobRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.GetObservationSourceRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation.Header` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation.HttpMethod` (enum)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation.HttpRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation.HttpResponse` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation.PathParam` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation.QueryParam` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListApiObservationTagsRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListApiObservationTagsResponse` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListApiObservationsRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListApiObservationsResponse` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListApiOperationsRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListApiOperationsResponse` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListObservationJobsRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListObservationJobsResponse` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListObservationSourcesRequest` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListObservationSourcesResponse` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ObservationJob` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ObservationJob.State` (enum)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ObservationSource` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ObservationSource.State` (enum)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.OperationMetadata` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.TagAction` (message)
- `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.TagAction.Action` (enum)

## ApiDiscoveryObservation

Shadow API Discovery Observation Service.

| BatchEditTagsApiObservations |
|---|
| `` rpc BatchEditTagsApiObservations(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.BatchEditTagsApiObservationsRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.BatchEditTagsApiObservationsResponse`) `` BatchEditTagsApiObservations adds or removes Tags for ApiObservations. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `apim.apiObservations.batchEditTags` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateObservationJob |
|---|
| `` rpc CreateObservationJob(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.CreateObservationJobRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.longrunning#google.longrunning.Operation`) `` 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. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `apim.observationJobs.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateObservationSource |
|---|
| `` rpc CreateObservationSource(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.CreateObservationSourceRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.longrunning#google.longrunning.Operation`) `` 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. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `apim.observationSources.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteObservationJob |
|---|
| `` rpc DeleteObservationJob(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.DeleteObservationJobRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.longrunning#google.longrunning.Operation`) `` DeleteObservationJob deletes an ObservationJob. This method will fail if the observation job is currently being used by any ObservationSource, even if not enabled. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `apim.observationJobs.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteObservationSource |
|---|
| `` rpc DeleteObservationSource(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.DeleteObservationSourceRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.longrunning#google.longrunning.Operation`) `` DeleteObservationSource deletes an observation source. This method will fail if the observation source is currently being used by any ObservationJob, even if not enabled. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `apim.observationSources.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DisableObservationJob |
|---|
| `` rpc DisableObservationJob(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.DisableObservationJobRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.longrunning#google.longrunning.Operation`) `` Disables the given ObservationJob. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `apim.observationJobs.disable` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| EnableObservationJob |
|---|
| `` rpc EnableObservationJob(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.EnableObservationJobRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.longrunning#google.longrunning.Operation`) `` Enables the given ObservationJob. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `apim.observationJobs.enable` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetApiObservation |
|---|
| `` rpc GetApiObservation(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.GetApiObservationRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ApiObservation`) `` GetApiObservation retrieves a single ApiObservation by name. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `apim.apiObservations.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetApiOperation |
|---|
| `` rpc GetApiOperation(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.GetApiOperationRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ApiOperation`) `` GetApiOperation retrieves a single ApiOperation by name. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `apim.apiOperations.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetObservationJob |
|---|
| `` rpc GetObservationJob(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.GetObservationJobRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ObservationJob`) `` GetObservationJob retrieves a single ObservationJob by name. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `apim.observationJobs.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetObservationSource |
|---|
| `` rpc GetObservationSource(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.GetObservationSourceRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ObservationSource`) `` GetObservationSource retrieves a single ObservationSource by name. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `apim.observationSources.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListApiObservationTags |
|---|
| `` rpc ListApiObservationTags(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListApiObservationTagsRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListApiObservationTagsResponse`) `` ListApiObservationTags lists all extant tags on any observation in the given project. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `apim.locations.listApiObservationTags` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListApiObservations |
|---|
| `` rpc ListApiObservations(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListApiObservationsRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListApiObservationsResponse`) `` ListApiObservations gets all ApiObservations for a given project and location and ObservationJob. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `apim.apiObservations.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListApiOperations |
|---|
| `` rpc ListApiOperations(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListApiOperationsRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListApiOperationsResponse`) `` ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `apim.apiOperations.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListObservationJobs |
|---|
| `` rpc ListObservationJobs(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListObservationJobsRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListObservationJobsResponse`) `` ListObservationJobs gets all ObservationJobs for a given project and location. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `apim.observationJobs.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListObservationSources |
|---|
| `` rpc ListObservationSources(`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListObservationSourcesRequest`) returns (`https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ListObservationSourcesResponse`) `` ListObservationSources gets all ObservationSources for a given project and location. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `apim.observationSources.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## ApiDiscoveryOperationMetadata

Represents the metadata of the long-running operation.

| Fields ||
|---|---|
| `create_time` | `` `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` `` Output only. The time the operation was created. |
| `end_time` | `` `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` `` Output only. The time the operation finished running. |
| `target` | `string` Output only. Server-defined resource path for the target of the operation. |
| `verb` | `string` Output only. Name of the verb executed by the operation. |
| `status_message` | `string` Output only. Human-readable status of the operation, if any. |
| `requested_cancellation` | `bool` Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have \[Operation.error\]\[\] value with a `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.rpc#google.rpc.Status.FIELDS.int32.google.rpc.Status.code` of 1, corresponding to `Code.CANCELLED`. |
| `api_version` | `string` Output only. API version used to start the operation. |

## ApiObservation

Message describing ApiObservation object

| Fields ||
|---|---|
| `name` | `string` Identifier. Name of resource |
| `style` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ApiObservation.Style` `` Style of ApiObservation |
| `server_ips[]` | `string` 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"`. |
| `hostname` | `string` The hostname of requests processed for this Observation. |
| `source_locations[]` | `string` Location of the Observation Source, for example "us-central1" or "europe-west1." |
| `tags[]` | `string` User-defined tags to organize and sort |
| `api_operation_count` | `int64` The number of observed API Operations. |
| `create_time` | `` `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` `` Create time stamp |
| `update_time` | `` `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` `` Update time stamp |
| `last_event_detected_time` | `` `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` `` Last event detected time stamp |

## Style

ApiObservation protocol style For MVP, only support REST and unknown protocol

| Enums ||
|---|---|
| `STYLE_UNSPECIFIED` | Unknown style |
| `REST` | Style is Rest API |
| `GRPC` | Style is Grpc API |
| `GRAPHQL` | Style is GraphQL API |

## ApiOperation

Message describing ApiOperation object

| Fields ||
|---|---|
| `name` | `string` Identifier. Name of resource |
| `first_seen_time` | `` `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` `` First seen time stamp |
| `last_seen_time` | `` `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` `` Last seen time stamp |
| `count` | `int64` The number of occurrences of this API Operation. |
| Union field `operation`. ApiOperation protocol style `operation` can be only one of the following: ||
| `http_operation` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation` `` An HTTP Operation. |

## BatchEditTagsApiObservationsRequest

Message for requesting batch edit tags for ApiObservations

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} |
| `requests[]` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.EditTagsApiObservationsRequest` `` Required. The request message specifying the resources to update. A maximum of 1000 apiObservations can be modified in a batch. |

## BatchEditTagsApiObservationsResponse

Message for response to edit Tags for ApiObservations

| Fields ||
|---|---|
| `api_observations[]` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ApiObservation` `` ApiObservations that were changed |

## CreateObservationJobRequest

Message for creating an ObservationJob

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource where this ObservationJob will be created. Format: projects/{project}/locations/{location} |
| `observation_job_id` | `string` Required. The ID to use for the Observation Job. This value should be 4-63 characters, and valid characters are /\[a-z\]\[0-9\]-/. |
| `observation_job` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ObservationJob` `` Required. The ObservationJob to create. |
| `request_id` | `string` 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). |

## CreateObservationSourceRequest

Message for creating an ObservationSource

| Fields ||
|---|---|
| `parent` | `string` Required. Value for parent. |
| `observation_source_id` | `string` Required. The ID to use for the Observation Source. This value should be 4-63 characters, and valid characters are /\[a-z\]\[0-9\]-/. |
| `observation_source` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ObservationSource` `` Required. The ObservationSource to create. |
| `request_id` | `string` 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). |

## DataType

Type of data

| Enums ||
|---|---|
| `DATA_TYPE_UNSPECIFIED` | Unspecified data type |
| `BOOL` | Boolean data type |
| `INTEGER` | Integer data type |
| `FLOAT` | Float data type |
| `STRING` | String data type |
| `UUID` | UUID data type |

## DeleteObservationJobRequest

Message for deleting an ObservationJob

| Fields ||
|---|---|
| `name` | `string` Required. Name of the resource Format: projects/{project}/locations/{location}/observationJobs/{observation_job} |

## DeleteObservationSourceRequest

Message for deleting an ObservationSource

| Fields ||
|---|---|
| `name` | `string` Required. Name of the resource Format: projects/{project}/locations/{location}/observationSources/{source} |

## DisableObservationJobRequest

Message for disabling an ObservationJob

| Fields ||
|---|---|
| `name` | `string` Required. The name of the ObservationJob to disable. Format: projects/{project}/locations/{location}/observationJobs/{job} |

## EditTagsApiObservationsRequest

Message for requesting edit tags for ApiObservation

| Fields ||
|---|---|
| `api_observation_id` | `string` Required. Identifier of ApiObservation need to be edit tags Format example: "apigee.googleapis.com\|us-west1\|443" |
| `tag_actions[]` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.TagAction` `` Required. Tag actions to be applied |

## EnableObservationJobRequest

Message for enabling an ObservationJob

| Fields ||
|---|---|
| `name` | `string` Required. The name of the ObservationJob to enable. Format: projects/{project}/locations/{location}/observationJobs/{job} |

## GclbObservationSource

The GCLB observation source.

| Fields ||
|---|---|
| `psc_network_configs[]` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.GclbObservationSource.PscNetworkConfig` `` 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. |

## PscNetworkConfig

Network information for setting up a PSC connection.

| Fields ||
|---|---|
| `network` | `string` Required. The VPC network. Format: `projects/{project_id}/global/networks/{network}` |
| `subnetwork` | `string` 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} |

## GetApiObservationRequest

Message for getting an ApiObservation

| Fields ||
|---|---|
| `name` | `string` Required. The name of the ApiObservation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation} |

## GetApiOperationRequest

Message for getting an ApiOperation

| Fields ||
|---|---|
| `name` | `string` Required. The name of the ApiOperation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation}/apiOperation/{api_operation} |

## GetObservationJobRequest

Message for getting an ObservationJob

| Fields ||
|---|---|
| `name` | `string` Required. The name of the ObservationJob to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{job} |

## GetObservationSourceRequest

Message for getting an ObservationSource

| Fields ||
|---|---|
| `name` | `string` Required. The name of the ObservationSource to retrieve. Format: projects/{project}/locations/{location}/observationSources/{source} |

## HttpOperation

An HTTP-based API Operation, sometimes called a "REST" Operation.

| Fields ||
|---|---|
| `path` | `string` Path of the HTTP request. |
| `path_params[]` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation.PathParam` `` Path params of HttpOperation |
| `query_params` | ``map<string, `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation.QueryParam`>`` Query params of HttpOperation |
| `method` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation.HttpMethod` `` HTTP Method. |
| `request` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation.HttpRequest` `` Request metadata. |
| `response` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation.HttpResponse` `` Response metadata. |

## Header

An aggregation of HTTP header occurrences.

| Fields ||
|---|---|
| `name` | `string` Header name. |
| `count` | `int64` The number of occurrences of this Header across transactions. |
| `data_type` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.DataType` `` Data type of header |

## HttpMethod

HTTP method

| Enums ||
|---|---|
| `HTTP_METHOD_UNSPECIFIED` | Unspecified HTTP method |
| `GET` | GET HTTP method |
| `HEAD` | HEAD HTTP method |
| `POST` | POST HTTP method |
| `PUT` | PUT HTTP method |
| `PATCH` | PATCH HTTP method |
| `DELETE` | DELETE HTTP method |
| `TRACE` | TRACE HTTP method |
| `OPTIONS` | OPTIONS HTTP method |
| `CONNECT` | CONNECT HTTP method |

## HttpRequest

An aggregation of HTTP requests.

| Fields ||
|---|---|
| `headers` | ``map<string, `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation.Header`>`` Unordered map from header name to header metadata |

## HttpResponse

An aggregation of HTTP responses.

| Fields ||
|---|---|
| `headers` | ``map<string, `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.HttpOperation.Header`>`` Unordered map from header name to header metadata |
| `response_codes` | `map<int32, int64>` Map of status code to observed count |

## PathParam

HTTP Path parameter.

| Fields ||
|---|---|
| `position` | `int32` Segment location in the path, 1-indexed |
| `data_type` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.DataType` `` Data type of path param |

## QueryParam

An aggregation of HTTP query parameter occurrences.

| Fields ||
|---|---|
| `name` | `string` Name of query param |
| `count` | `int64` The number of occurrences of this query parameter across transactions. |
| `data_type` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.DataType` `` Data type of path param |

## ListApiObservationTagsRequest

Message for requesting the full list of tags

| Fields ||
|---|---|
| `parent` | `string` Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location} |
| `page_size` | `int32` 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. |
| `page_token` | `string` 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. |

## ListApiObservationTagsResponse

Message for response to listing tags

| Fields ||
|---|---|
| `api_observation_tags[]` | `string` The tags from the specified project |
| `next_page_token` | `string` A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListApiObservationsRequest

Message for requesting list of ApiObservations

| Fields ||
|---|---|
| `parent` | `string` Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} |
| `page_size` | `int32` 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. |
| `page_token` | `string` 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. |

## ListApiObservationsResponse

Message for response to listing ApiObservations

| Fields ||
|---|---|
| `api_observations[]` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ApiObservation` `` The ApiObservation from the specified project and location and ObservationJobs. |
| `next_page_token` | `string` A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListApiOperationsRequest

Message for requesting list of ApiOperations

| Fields ||
|---|---|
| `parent` | `string` Required. The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation} |
| `page_size` | `int32` 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. |
| `page_token` | `string` 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. |

## ListApiOperationsResponse

Message for response to listing ApiOperations

| Fields ||
|---|---|
| `api_operations[]` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ApiOperation` `` The ApiOperations from the specified project and location and ObservationJob and ApiObservation. |
| `next_page_token` | `string` A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListObservationJobsRequest

Message for requesting list of ObservationJobs

| Fields ||
|---|---|
| `parent` | `string` Required. The parent, which owns this collection of ObservationJobs. Format: projects/{project}/locations/{location} |
| `page_size` | `int32` 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. |
| `page_token` | `string` 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. |

## ListObservationJobsResponse

Message for response to listing ObservationJobs

| Fields ||
|---|---|
| `observation_jobs[]` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ObservationJob` `` The ObservationJob from the specified project and location. |
| `next_page_token` | `string` 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[]` | `string` Locations that could not be reached. |

## ListObservationSourcesRequest

Message for requesting list of ObservationSources

| Fields ||
|---|---|
| `parent` | `string` Required. The parent, which owns this collection of ObservationSources. Format: projects/{project}/locations/{location} |
| `page_size` | `int32` 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. |
| `page_token` | `string` 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. |

## ListObservationSourcesResponse

Message for response to listing ObservationSources

| Fields ||
|---|---|
| `observation_sources[]` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ObservationSource` `` The ObservationSource from the specified project and location. |
| `next_page_token` | `string` 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[]` | `string` Locations that could not be reached. |

## ObservationJob

Message describing ObservationJob object

| Fields ||
|---|---|
| `name` | `string` Identifier. name of resource Format: projects/{project}/locations/{location}/observationJobs/{observation_job} |
| `state` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ObservationJob.State` `` Output only. The observation job state |
| `sources[]` | `string` Optional. These should be of the same kind of source. |
| `create_time` | `` `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` `` Output only. \[Output only\] Create time stamp |
| `update_time` | `` `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` `` Output only. \[Output only\] Update time stamp |

## State

Observation job state

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Unspecified state |
| `CREATING` | Job is in the creating state |
| `ENABLING` | Job is in the enabling state |
| `ENABLED` | Job is enabled |
| `DISABLING` | Job is in the disabling state |
| `DISABLED` | Job is disabled |
| `DELETING` | Job is being deleted |
| `ERROR` | Job is in an error state |

## ObservationSource

Observation source configuration types

| Fields ||
|---|---|
| `name` | `string` Identifier. name of resource For MVP, each region can only have 1 source. |
| `state` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.ObservationSource.State` `` Output only. The observation source state |
| `create_time` | `` `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` `` Output only. \[Output only\] Create time stamp |
| `update_time` | `` `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` `` Output only. \[Output only\] Update time stamp |
| Union field `source`. Type of the source `source` can be only one of the following: ||
| `gclb_observation_source` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.GclbObservationSource` `` The GCLB observation source |

## State

Observation source state

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Unspecified state |
| `CREATING` | Source is in the creating state |
| `CREATED` | Source has been created and is ready to use |
| `DELETING` | Source is being deleted |
| `ERROR` | Source is in an error state |

## OperationMetadata

Represents the metadata of the long-running operation.

| Fields ||
|---|---|
| `create_time` | `` `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` `` Output only. The time the operation was created. |
| `end_time` | `` `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` `` Output only. The time the operation finished running. |
| `target` | `string` Output only. Server-defined resource path for the target of the operation. |
| `verb` | `string` Output only. Name of the verb executed by the operation. |
| `status_message` | `string` Output only. Human-readable status of the operation, if any. |
| `requested_cancellation` | `bool` Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have \[Operation.error\]\[\] value with a `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.rpc#google.rpc.Status.FIELDS.int32.google.rpc.Status.code` of 1, corresponding to `Code.CANCELLED`. |
| `api_version` | `string` Output only. API version used to start the operation. |

## TagAction

Message for edit tag action

| Fields ||
|---|---|
| `tag` | `string` Required. Tag to be added or removed |
| `action` | `` `https://docs.cloud.google.com/apigee/docs/reference/apis/apim/rpc/google.cloud.apim.v1alpha#google.cloud.apim.v1alpha.TagAction.Action` `` Required. Action to be applied |

## Action

The type of action performed on a tag in a TagAction.

| Enums ||
|---|---|
| `ACTION_UNSPECIFIED` | Unspecified. |
| `ADD` | Addition of a Tag. |
| `REMOVE` | Removal of a Tag. |