GoogleCloudApihubV1Attribute

import type { GoogleCloudApihubV1Attribute } from "https://googleapis.deno.dev/v1/apihub:v1.ts";

An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.

interface GoogleCloudApihubV1Attribute {

allowedValues?: GoogleCloudApihubV1AllowedValue[];

cardinality?: number;

readonly createTime?: Date;

dataType?:

| "DATA_TYPE_UNSPECIFIED"

| "ENUM"

| "JSON"

| "STRING"

| "URI";

readonly definitionType?: "DEFINITION_TYPE_UNSPECIFIED" | "SYSTEM_DEFINED" | "USER_DEFINED";

description?: string;

displayName?: string;

readonly mandatory?: boolean;

name?: string;

scope?:

| "SCOPE_UNSPECIFIED"

| "API"

| "VERSION"

| "SPEC"

| "API_OPERATION"

| "DEPLOYMENT"

| "DEPENDENCY"

| "DEFINITION"

| "EXTERNAL_API"

| "PLUGIN";

readonly updateTime?: Date;

}

§Properties

allowedValues?: GoogleCloudApihubV1AllowedValue[]

[src]

Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.

cardinality?: number

[src]

Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute.

readonly createTime?: Date

[src]

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

dataType?: "DATA_TYPE_UNSPECIFIED" | "ENUM" | "JSON" | "STRING" | "URI"

[src]

Required. The type of the data of the attribute.

readonly definitionType?: "DEFINITION_TYPE_UNSPECIFIED" | "SYSTEM_DEFINED" | "USER_DEFINED"

[src]

Output only. The definition type of the attribute.

description?: string

[src]

Optional. The description of the attribute.

displayName?: string

[src]

Required. The display name of the attribute.

readonly mandatory?: boolean

[src]

Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory.

name?: string

[src]

Identifier. The name of the attribute in the API Hub. Format: projects/{project}/locations/{location}/attributes/{attribute}

[src]

Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked.

readonly updateTime?: Date

[src]

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