Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13153246.5 KB
projects

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.

post/v1alpha/{+parent}/observationJobs

Path parameters

parentstring required

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

Query parameters

observationJobIdstring

Required. The ID to use for the Observation Job. This value should be 4-63 characters, and valid characters are /a-z-/.

requestIdstring

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

Request body

createTimestring google-datetime

Output only. [Output only] Create time stamp

namestring

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

updateTimestring google-datetime

Output only. [Output only] Update time stamp

sourcesstring[]

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

state'STATE_UNSPECIFIED' | 'CREATING' | 'ENABLING' | 'ENABLED' | 'DISABLING' | 'DISABLED' | 'DELETING' | 'ERROR'

Output only. The observation job state

Response

Successful response