API hub v1 API - Class Version (1.0.0-beta02)

public sealed class Version : IMessage<Version>, IEquatable<Version>, IDeepCloneable<Version>, IBufferMessage, IMessage

Reference documentation and code samples for the API hub v1 API class Version.

Represents a version of the API resource in API hub. This is also referred to as the API version.

Inheritance

object > Version

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

Version()

public Version()

Version(Version)

public Version(Version other)
Parameter
Name Description
other Version

Properties

Accreditation

public AttributeValues Accreditation { get; set; }

Optional. The accreditations associated with the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-accreditation attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Property Value
Type Description
AttributeValues

ApiOperations

public RepeatedField<string> ApiOperations { get; }

Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

Property Value
Type Description
RepeatedFieldstring

ApiOperationsAsApiOperationNames

public ResourceNameList<ApiOperationName> ApiOperationsAsApiOperationNames { get; }

ApiOperationName-typed view over the ApiOperations resource name property.

Property Value
Type Description
ResourceNameListApiOperationName

Attributes

public MapField<string, AttributeValues> Attributes { get; }

Optional. The list of user defined attributes associated with the Version 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

Compliance

public AttributeValues Compliance { get; set; }

Optional. The compliance associated with the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-compliance attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Property Value
Type Description
AttributeValues

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The time at which the version was created.

Property Value
Type Description
Timestamp

Definitions

public RepeatedField<string> Definitions { get; }

Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}

Property Value
Type Description
RepeatedFieldstring

DefinitionsAsDefinitionNames

public ResourceNameList<DefinitionName> DefinitionsAsDefinitionNames { get; }

DefinitionName-typed view over the Definitions resource name property.

Property Value
Type Description
ResourceNameListDefinitionName

Deployments

public RepeatedField<string> Deployments { get; }

Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is projects/{project}/locations/{location}/deployments/{deployment}

Property Value
Type Description
RepeatedFieldstring

DeploymentsAsDeploymentNames

public ResourceNameList<DeploymentName> DeploymentsAsDeploymentNames { get; }

DeploymentName-typed view over the Deployments resource name property.

Property Value
Type Description
ResourceNameListDeploymentName

Description

public string Description { get; set; }

Optional. The description of the version.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Required. The display name of the version.

Property Value
Type Description
string

Documentation

public Documentation Documentation { get; set; }

Optional. The documentation of the version.

Property Value
Type Description
Documentation

Lifecycle

public AttributeValues Lifecycle { get; set; }

Optional. The lifecycle of the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-lifecycle attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Property Value
Type Description
AttributeValues

Name

public string Name { get; set; }

Identifier. The name of the version.

Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

Property Value
Type Description
string

SelectedDeployment

public string SelectedDeployment { get; set; }

Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is projects/{project}/locations/{location}/deployments/{deployment}

Property Value
Type Description
string

SelectedDeploymentAsDeploymentName

public DeploymentName SelectedDeploymentAsDeploymentName { get; set; }

DeploymentName-typed view over the SelectedDeployment resource name property.

Property Value
Type Description
DeploymentName

Specs

public RepeatedField<string> Specs { get; }

Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

Property Value
Type Description
RepeatedFieldstring

SpecsAsSpecNames

public ResourceNameList<SpecName> SpecsAsSpecNames { get; }

SpecName-typed view over the Specs resource name property.

Property Value
Type Description
ResourceNameListSpecName

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The time at which the version was last updated.

Property Value
Type Description
Timestamp

VersionName

public VersionName VersionName { get; set; }

VersionName-typed view over the Name resource name property.

Property Value
Type Description
VersionName