Reference documentation and code samples for the Google Cloud Api Hub V1 Client class Definition.
Represents a definition for example schema, request, response definitions contained in an API version.
A definition is added/updated/deleted in an API version when a new spec is
added or an existing spec is updated/deleted in a version. Currently,
definition will be created only corresponding to OpenAPI spec as parsing is
supported for OpenAPI spec. Also, within OpenAPI spec, only schema
object
is supported.
Generated from protobuf message google.cloud.apihub.v1.Definition
Namespace
Google \ Cloud \ ApiHub \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ schema
↳ name
string
Identifier. The name of the definition. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
↳ 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
int
Output only. The type of the definition.
↳ create_time
↳ update_time
↳ attributes
array| Google\Protobuf\Internal\MapField
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.
getSchema
Output only. The value of a schema definition.
hasSchema
setSchema
Output only. The value of a schema definition.
$this
getName
Identifier. The name of the definition.
Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
string
setName
Identifier. The name of the definition.
Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
var
string
$this
getSpec
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}
string
setSpec
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}
var
string
$this
getType
Output only. The type of the definition.
setType
Output only. The type of the definition.
$this
getCreateTime
Output only. The time at which the definition was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which the definition was created.
$this
getUpdateTime
Output only. The time at which the definition was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which the definition was last updated.
$this
getAttributes
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.
setAttributes
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.
$this
getValue
string
