Index
ApiDiscoveryObservation
(interface)ApiDiscoveryOperationMetadata
(message)ApiObservation
(message)ApiObservation.Style
(enum)ApiOperation
(message)BatchEditTagsApiObservationsRequest
(message)BatchEditTagsApiObservationsResponse
(message)CreateObservationJobRequest
(message)CreateObservationSourceRequest
(message)DataType
(enum)DeleteObservationJobRequest
(message)DeleteObservationSourceRequest
(message)DisableObservationJobRequest
(message)EditTagsApiObservationsRequest
(message)EnableObservationJobRequest
(message)GclbObservationSource
(message)GclbObservationSource.PscNetworkConfig
(message)GetApiObservationRequest
(message)GetApiOperationRequest
(message)GetObservationJobRequest
(message)GetObservationSourceRequest
(message)HttpOperation
(message)HttpOperation.Header
(message)HttpOperation.HttpMethod
(enum)HttpOperation.HttpRequest
(message)HttpOperation.HttpResponse
(message)HttpOperation.PathParam
(message)HttpOperation.QueryParam
(message)ListApiObservationTagsRequest
(message)ListApiObservationTagsResponse
(message)ListApiObservationsRequest
(message)ListApiObservationsResponse
(message)ListApiOperationsRequest
(message)ListApiOperationsResponse
(message)ListObservationJobsRequest
(message)ListObservationJobsResponse
(message)ListObservationSourcesRequest
(message)ListObservationSourcesResponse
(message)ObservationJob
(message)ObservationJob.State
(enum)ObservationSource
(message)ObservationSource.State
(enum)OperationMetadata
(message)TagAction
(message)TagAction.Action
(enum)
ApiDiscoveryObservation
Shadow API Discovery Observation Service.
BatchEditTagsApiObservations |
---|
BatchEditTagsApiObservations adds or removes Tags for ApiObservations.
|
CreateObservationJob |
---|
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.
|
CreateObservationSource |
---|
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.
|
DeleteObservationJob |
---|
DeleteObservationJob deletes an ObservationJob. This method will fail if the observation job is currently being used by any ObservationSource, even if not enabled.
|
DeleteObservationSource |
---|
DeleteObservationSource deletes an observation source. This method will fail if the observation source is currently being used by any ObservationJob, even if not enabled.
|
DisableObservationJob |
---|
Disables the given ObservationJob.
|
EnableObservationJob |
---|
Enables the given ObservationJob.
|
GetApiObservation |
---|
GetApiObservation retrieves a single ApiObservation by name.
|
GetApiOperation |
---|
GetApiOperation retrieves a single ApiOperation by name.
|
GetObservationJob |
---|
GetObservationJob retrieves a single ObservationJob by name.
|
GetObservationSource |
---|
GetObservationSource retrieves a single ObservationSource by name.
|
ListApiObservationTags |
---|
ListApiObservationTags lists all extant tags on any observation in the given project.
|
ListApiObservations |
---|
ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.
|
ListApiOperations |
---|
ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.
|
ListObservationJobs |
---|
ListObservationJobs gets all ObservationJobs for a given project and location.
|
ListObservationSources |
---|
ListObservationSources gets all ObservationSources for a given project and location.
|
ApiDiscoveryOperationMetadata
Represents the metadata of the long-running operation.
Fields | |
---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
target |
Output only. Server-defined resource path for the target of the operation. |
verb |
Output only. Name of the verb executed by the operation. |
status_message |
Output only. Human-readable status of the operation, if any. |
requested_cancellation |
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with a |
api_version |
Output only. API version used to start the operation. |
ApiObservation
Message describing ApiObservation object
Fields | |
---|---|
name |
Identifier. Name of resource |
style |
Style of ApiObservation |
server_ips[] |
The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: |
hostname |
The hostname of requests processed for this Observation. |
source_locations[] |
Location of the Observation Source, for example "us-central1" or "europe-west1." |
tags[] |
User-defined tags to organize and sort |
api_operation_count |
The number of observed API Operations. |
create_time |
Create time stamp |
update_time |
Update time stamp |
last_event_detected_time |
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 |
Identifier. Name of resource |
first_seen_time |
First seen time stamp |
last_seen_time |
Last seen time stamp |
count |
The number of occurrences of this API Operation. |
Union field operation . ApiOperation protocol style operation can be only one of the following: |
|
http_operation |
An HTTP Operation. |
BatchEditTagsApiObservationsRequest
Message for requesting batch edit tags for ApiObservations
Fields | |
---|---|
parent |
Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} |
requests[] |
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[] |
ApiObservations that were changed |
CreateObservationJobRequest
Message for creating an ObservationJob
Fields | |
---|---|
parent |
Required. The parent resource where this ObservationJob will be created. Format: projects/{project}/locations/{location} |
observation_job_id |
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 |
Required. The ObservationJob to create. |
request_id |
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 |
Required. Value for parent. |
observation_source_id |
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 |
Required. The ObservationSource to create. |
request_id |
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 |
Required. Name of the resource Format: projects/{project}/locations/{location}/observationJobs/{observation_job} |
DeleteObservationSourceRequest
Message for deleting an ObservationSource
Fields | |
---|---|
name |
Required. Name of the resource Format: projects/{project}/locations/{location}/observationSources/{source} |
DisableObservationJobRequest
Message for disabling an ObservationJob
Fields | |
---|---|
name |
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 |
Required. Identifier of ApiObservation need to be edit tags Format example: "apigee.googleapis.com|us-west1|443" |
tag_actions[] |
Required. Tag actions to be applied |
EnableObservationJobRequest
Message for enabling an ObservationJob
Fields | |
---|---|
name |
Required. The name of the ObservationJob to enable. Format: projects/{project}/locations/{location}/observationJobs/{job} |
GclbObservationSource
The GCLB observation source.
Fields | |
---|---|
psc_network_configs[] |
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 |
Required. The VPC network. Format: |
subnetwork |
Required. The subnetwork in the source region that will be used to connect to the Cloud Load Balancers via PSC NEGs. Must belong to |
GetApiObservationRequest
Message for getting an ApiObservation
Fields | |
---|---|
name |
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 |
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 |
Required. The name of the ObservationJob to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{job} |
GetObservationSourceRequest
Message for getting an ObservationSource
Fields | |
---|---|
name |
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 |
Path of the HTTP request. |
path_params[] |
Path params of HttpOperation |
query_params |
Query params of HttpOperation |
method |
HTTP Method. |
request |
Request metadata. |
response |
Response metadata. |
Header
An aggregation of HTTP header occurrences.
Fields | |
---|---|
name |
Header name. |
count |
The number of occurrences of this Header across transactions. |
data_type |
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 |
Unordered map from header name to header metadata |
HttpResponse
An aggregation of HTTP responses.
Fields | |
---|---|
headers |
Unordered map from header name to header metadata |
response_codes |
Map of status code to observed count |
PathParam
HTTP Path parameter.
Fields | |
---|---|
position |
Segment location in the path, 1-indexed |
data_type |
Data type of path param |
QueryParam
An aggregation of HTTP query parameter occurrences.
Fields | |
---|---|
name |
Name of query param |
count |
The number of occurrences of this query parameter across transactions. |
data_type |
Data type of path param |
ListApiObservationTagsRequest
Message for requesting the full list of tags
Fields | |
---|---|
parent |
Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location} |
page_size |
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 |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListApiObservationTagsResponse
Message for response to listing tags
Fields | |
---|---|
api_observation_tags[] |
The tags from the specified project |
next_page_token |
A token, which can be sent as |
ListApiObservationsRequest
Message for requesting list of ApiObservations
Fields | |
---|---|
parent |
Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} |
page_size |
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 |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListApiObservationsResponse
Message for response to listing ApiObservations
Fields | |
---|---|
api_observations[] |
The ApiObservation from the specified project and location and ObservationJobs. |
next_page_token |
A token, which can be sent as |
ListApiOperationsRequest
Message for requesting list of ApiOperations
Fields | |
---|---|
parent |
Required. The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation} |
page_size |
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 |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListApiOperationsResponse
Message for response to listing ApiOperations
Fields | |
---|---|
api_operations[] |
The ApiOperations from the specified project and location and ObservationJob and ApiObservation. |
next_page_token |
A token, which can be sent as |
ListObservationJobsRequest
Message for requesting list of ObservationJobs
Fields | |
---|---|
parent |
Required. The parent, which owns this collection of ObservationJobs. Format: projects/{project}/locations/{location} |
page_size |
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 |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListObservationJobsResponse
Message for response to listing ObservationJobs
Fields | |
---|---|
observation_jobs[] |
The ObservationJob from the specified project and location. |
next_page_token |
A token, which can be sent as |
unreachable[] |
Locations that could not be reached. |
ListObservationSourcesRequest
Message for requesting list of ObservationSources
Fields | |
---|---|
parent |
Required. The parent, which owns this collection of ObservationSources. Format: projects/{project}/locations/{location} |
page_size |
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 |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListObservationSourcesResponse
Message for response to listing ObservationSources
Fields | |
---|---|
observation_sources[] |
The ObservationSource from the specified project and location. |
next_page_token |
A token, which can be sent as |
unreachable[] |
Locations that could not be reached. |
ObservationJob
Message describing ObservationJob object
Fields | |
---|---|
name |
Identifier. name of resource Format: projects/{project}/locations/{location}/observationJobs/{observation_job} |
state |
Output only. The observation job state |
sources[] |
Optional. These should be of the same kind of source. |
create_time |
Output only. [Output only] Create time stamp |
update_time |
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 |
Identifier. name of resource For MVP, each region can only have 1 source. |
state |
Output only. The observation source state |
create_time |
Output only. [Output only] Create time stamp |
update_time |
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 |
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 |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
target |
Output only. Server-defined resource path for the target of the operation. |
verb |
Output only. Name of the verb executed by the operation. |
status_message |
Output only. Human-readable status of the operation, if any. |
requested_cancellation |
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with a |
api_version |
Output only. API version used to start the operation. |
TagAction
Message for edit tag action
Fields | |
---|---|
tag |
Required. Tag to be added or removed |
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. |