GoogleCloudApigeeV1ApiDoc class

ApiDoc represents an API catalog item.

Catalog items are used in two ways in a portal: - Users can browse and interact with a visual representation of the API documentation - The api_product_name field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products.

Constructors

GoogleCloudApigeeV1ApiDoc({bool? anonAllowed, String? apiProductName, List<String>? categoryIds, String? description, String? edgeAPIProductName, String? graphqlEndpointUrl, String? graphqlSchema, String? graphqlSchemaDisplayName, String? id, String? imageUrl, String? modified, bool? published, bool? requireCallbackUrl, String? siteId, String? specId, String? title, bool? visibility})
GoogleCloudApigeeV1ApiDoc.fromJson(Map json_)

Properties

anonAllowed ↔ bool?
Boolean flag that manages user access to the catalog item.
getter/setter pair
apiProductName ↔ String?
The name field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts).
getter/setter pair
categoryIds ↔ List<String>?
The IDs of the API categories to which this catalog item belongs.
getter/setter pair
description ↔ String?
Description of the catalog item.
getter/setter pair
edgeAPIProductName ↔ String?
DEPRECATED: use the apiProductName field instead
getter/setter pair
graphqlEndpointUrl ↔ String?
DEPRECATED: manage documentation through the getDocumentation and updateDocumentation methods
getter/setter pair
graphqlSchema ↔ String?
DEPRECATED: manage documentation through the getDocumentation and updateDocumentation methods
getter/setter pair
graphqlSchemaDisplayName ↔ String?
DEPRECATED: manage documentation through the getDocumentation and updateDocumentation methods
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String?
The ID of the catalog item.
getter/setter pair
imageUrl ↔ String?
Location of the image used for the catalog item in the catalog.
getter/setter pair
modified ↔ String?
Time the catalog item was last modified in milliseconds since epoch.
getter/setter pair
published ↔ bool?
Denotes whether the catalog item is published to the portal or is in a draft state.
getter/setter pair
requireCallbackUrl ↔ bool?
Whether a callback URL is required when this catalog item's API product is enabled in a developer app.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
siteId ↔ String?
The ID of the parent portal.
getter/setter pair
specId ↔ String?
DEPRECATED: DO NOT USE
getter/setter pair
title ↔ String?
The user-facing name of the catalog item.
getter/setter pair
visibility ↔ bool?
DEPRECATED: use the published field instead
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited