rpc BatchEditTagsApiObservations(BatchEditTagsApiObservationsRequest) returns (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 followingIAM permission on theparent resource:

• apim.apiObservations.batchEditTags

For more information, see theIAM documentation.

rpc CreateObservationJob(CreateObservationJobRequest) returns (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 followingIAM permission on theparent resource:

• apim.observationJobs.create

For more information, see theIAM documentation.

rpc CreateObservationSource(CreateObservationSourceRequest) returns (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 followingIAM permission on theparent resource:

• apim.observationSources.create

For more information, see theIAM documentation.

rpc DeleteObservationJob(DeleteObservationJobRequest) returns (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 followingIAM permission on thename resource:

• apim.observationJobs.delete

For more information, see theIAM documentation.

rpc DeleteObservationSource(DeleteObservationSourceRequest) returns (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 followingIAM permission on thename resource:

• apim.observationSources.delete

For more information, see theIAM documentation.

rpc DisableObservationJob(DisableObservationJobRequest) returns (Operation)

Disables the given ObservationJob.

Authorization scopes

Requires the following OAuth scope:

• https://www.googleapis.com/auth/cloud-platform

IAM Permissions

Requires the followingIAM permission on thename resource:

• apim.observationJobs.disable

For more information, see theIAM documentation.

rpc EnableObservationJob(EnableObservationJobRequest) returns (Operation)

Enables the given ObservationJob.

Authorization scopes

Requires the following OAuth scope:

• https://www.googleapis.com/auth/cloud-platform

IAM Permissions

Requires the followingIAM permission on thename resource:

• apim.observationJobs.enable

For more information, see theIAM documentation.

rpc GetApiObservation(GetApiObservationRequest) returns (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 followingIAM permission on thename resource:

• apim.apiObservations.get

For more information, see theIAM documentation.

rpc GetApiOperation(GetApiOperationRequest) returns (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 followingIAM permission on thename resource:

• apim.apiOperations.get

For more information, see theIAM documentation.

rpc GetObservationJob(GetObservationJobRequest) returns (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 followingIAM permission on thename resource:

• apim.observationJobs.get

For more information, see theIAM documentation.

rpc GetObservationSource(GetObservationSourceRequest) returns (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 followingIAM permission on thename resource:

• apim.observationSources.get

For more information, see theIAM documentation.

rpc ListApiObservationTags(ListApiObservationTagsRequest) returns (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 followingIAM permission on theparent resource:

• apim.locations.listApiObservationTags

For more information, see theIAM documentation.

rpc ListApiObservations(ListApiObservationsRequest) returns (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 followingIAM permission on theparent resource:

• apim.apiObservations.list

For more information, see theIAM documentation.

rpc ListApiOperations(ListApiOperationsRequest) returns (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 followingIAM permission on theparent resource:

• apim.apiOperations.list

For more information, see theIAM documentation.

rpc ListObservationJobs(ListObservationJobsRequest) returns (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 followingIAM permission on theparent resource:

• apim.observationJobs.list

For more information, see theIAM documentation.

rpc ListObservationSources(ListObservationSourcesRequest) returns (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 followingIAM permission on theparent resource:

• apim.observationSources.list

For more information, see theIAM documentation.

Timestamp

Output only. The time the operation was created.

Timestamp

Output only. The time the operation finished running.

string

Output only. Server-defined resource path for the target of the operation.

string

Output only. Name of the verb executed by the operation.

string

Output only. Human-readable status of the operation, if any.

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with agoogle.rpc.Status.code of 1, corresponding toCode.CANCELLED.

string

Output only. API version used to start the operation.

string

Identifier. Name of resource

Style

Style of ApiObservation

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".

string

The hostname of requests processed for this Observation.

string

Location of the Observation Source, for example "us-central1" or "europe-west1."

string

User-defined tags to organize and sort

int64

The number of observed API Operations.

Timestamp

Create time stamp

Timestamp

Update time stamp

Timestamp

Last event detected time stamp

string

Identifier. Name of resource

Timestamp

First seen time stamp

Timestamp

Last seen time stamp

int64

The number of occurrences of this API Operation.

HttpOperation

An HTTP Operation.

string

Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}

EditTagsApiObservationsRequest

Required. The request message specifying the resources to update. A maximum of 1000 apiObservations can be modified in a batch.

ApiObservation

ApiObservations that were changed

string

Required. The parent resource where this ObservationJob will be created. Format: projects/{project}/locations/{location}

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]-/.

ObservationJob

Required. The ObservationJob to create.

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).

string

Required. Value for parent.

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]-/.

ObservationSource

Required. The ObservationSource to create.

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).

string

Required. Name of the resource Format: projects/{project}/locations/{location}/observationJobs/{observation_job}

string

Required. Name of the resource Format: projects/{project}/locations/{location}/observationSources/{source}

string

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

string

Required. Identifier of ApiObservation need to be edit tags Format example: "apigee.googleapis.com|us-west1|443"

TagAction

Required. Tag actions to be applied

string

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

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.

string

Required. The VPC network. Format:projects/{project_id}/global/networks/{network}

string

Required. The subnetwork in the source region that will be used to connect to the Cloud Load Balancers via PSC NEGs. Must belong tonetwork. Format: projects/{project_id}/regions/{region}/subnetworks/{subnet}

string

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

string

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

string

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

string

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

string

Path of the HTTP request.

PathParam

Path params of HttpOperation

map<string,QueryParam>

Query params of HttpOperation

HttpMethod

HTTP Method.

HttpRequest

Request metadata.

HttpResponse

Response metadata.

string

Header name.

int64

The number of occurrences of this Header across transactions.

DataType

Data type of header

map<string,Header>

Unordered map from header name to header metadata

map<string,Header>

Unordered map from header name to header metadata

map<int32, int64>

Map of status code to observed count

int32

Segment location in the path, 1-indexed

DataType

Data type of path param

string

Name of query param

int64

The number of occurrences of this query parameter across transactions.

DataType

Data type of path param

string

Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location}

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.

string

Optional. A page token, received from a previousListApiObservationTags call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided toListApiObservationTags must match the call that provided the page token.

string

The tags from the specified project

string

A token, which can be sent aspage_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}

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.

string

Optional. A page token, received from a previousListApiObservations call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided toListApiObservations must match the call that provided the page token.

ApiObservation

The ApiObservation from the specified project and location and ObservationJobs.

string

A token, which can be sent aspage_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation}

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.

string

Optional. A page token, received from a previousListApiApiOperations call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided toListApiApiOperations must match the call that provided the page token.

ApiOperation

The ApiOperations from the specified project and location and ObservationJob and ApiObservation.

string

A token, which can be sent aspage_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. The parent, which owns this collection of ObservationJobs. Format: projects/{project}/locations/{location}

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.

string

Optional. A page token, received from a previousListObservationJobs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided toListObservationJobs must match the call that provided the page token.

ObservationJob

The ObservationJob from the specified project and location.

string

A token, which can be sent aspage_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Locations that could not be reached.

string

Required. The parent, which owns this collection of ObservationSources. Format: projects/{project}/locations/{location}

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.

string

Optional. A page token, received from a previousListObservationSources call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided toListObservationSources must match the call that provided the page token.

ObservationSource

The ObservationSource from the specified project and location.

string

A token, which can be sent aspage_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Locations that could not be reached.

string

Identifier. name of resource Format: projects/{project}/locations/{location}/observationJobs/{observation_job}

State

Output only. The observation job state

string

Optional. These should be of the same kind of source.

Timestamp

Output only. [Output only] Create time stamp

Timestamp

Output only. [Output only] Update time stamp

string

Identifier. name of resource For MVP, each region can only have 1 source.

State

Output only. The observation source state

Timestamp

Output only. [Output only] Create time stamp

Timestamp

Output only. [Output only] Update time stamp

GclbObservationSource

The GCLB observation source

Timestamp

Output only. The time the operation was created.

Timestamp

Output only. The time the operation finished running.

string

Output only. Server-defined resource path for the target of the operation.

string

Output only. Name of the verb executed by the operation.

string

Output only. Human-readable status of the operation, if any.

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with agoogle.rpc.Status.code of 1, corresponding toCode.CANCELLED.

string

Output only. API version used to start the operation.

string

Required. Tag to be added or removed

Action

Required. Action to be applied