public sealed class Definition : IMessage<Definition>, IEquatable<Definition>, IDeepCloneable<Definition>, IBufferMessage, IMessageReference documentation and code samples for the API hub v1 API 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.
Implements
IMessageDefinition, IEquatableDefinition, IDeepCloneableDefinition, IBufferMessage, IMessageNamespace
Google.Cloud.ApiHub.V1Assembly
Google.Cloud.ApiHub.V1.dll
Constructors
Definition()
public Definition()Definition(Definition)
public Definition(Definition other)| Parameter | |
|---|---|
| Name | Description |
other |
Definition |
Properties
Attributes
public MapField<string, AttributeValues> Attributes { get; }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.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringAttributeValues |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. The time at which the definition was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
DefinitionName
public DefinitionName DefinitionName { get; set; }DefinitionName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
DefinitionName |
|
Name
public string Name { get; set; }Identifier. The name of the definition.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
| Property Value | |
|---|---|
| Type | Description |
string |
|
Schema
public Schema Schema { get; set; }Output only. The value of a schema definition.
| Property Value | |
|---|---|
| Type | Description |
Schema |
|
Spec
public string Spec { get; set; }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}
| Property Value | |
|---|---|
| Type | Description |
string |
|
SpecAsSpecName
public SpecName SpecAsSpecName { get; set; }| Property Value | |
|---|---|
| Type | Description |
SpecName |
|
Type
public Definition.Types.Type Type { get; set; }Output only. The type of the definition.
| Property Value | |
|---|---|
| Type | Description |
DefinitionTypesType |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. The time at which the definition was last updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
ValueCase
public Definition.ValueOneofCase ValueCase { get; }| Property Value | |
|---|---|
| Type | Description |
DefinitionValueOneofCase |
|