definitions

Creates, updates, deletes, gets or lists a definitions resource.

Overview

Name	definitions
Type	Resource
Id	google.apihub.definitions

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the definition. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
attributes	object	Optional. The list of user defined attributes associated with the definition resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.
createTime	string (google-datetime)	Output only. The time at which the definition was created.
schema	object	Output only. The value of a schema definition. (id: GoogleCloudApihubV1Schema)
spec	string	Output only. The name of the spec from where the definition was parsed. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
type	string	Output only. The type of the definition.
updateTime	string (google-datetime)	Output only. The time at which the definition was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, apisId, versionsId, definitionsId		Get details about a definition in an API version.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
apisId	string
definitionsId	string
locationsId	string
projectsId	string
versionsId	string

SELECT examples

get

Get details about a definition in an API version.

SELECT
name,
attributes,
createTime,
schema,
spec,
type,
updateTime
FROM google.apihub.definitions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND apisId = '{{ apisId }}' -- required
AND versionsId = '{{ versionsId }}' -- required
AND definitionsId = '{{ definitionsId }}' -- required;