GoogleCloudApigeeV1ApiDoc (Apigee API v1-rev20251125-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.apigee.v1.model.GoogleCloudApigeeV1ApiDoc

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudApigeeV1ApiDoc
extends com.google.api.client.json.GenericJson
```
`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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Apigee API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudApigeeV1ApiDoc()

Constructors
Constructor and Description
`GoogleCloudApigeeV1ApiDoc()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudApigeeV1ApiDoc`	`clone()`
`Boolean`	`getAnonAllowed()` Optional.
`String`	`getApiProductName()` Required.
`List<String>`	`getCategoryIds()` Optional.
`String`	`getDescription()` Optional.
`String`	`getEdgeAPIProductName()` Optional.
`String`	`getGraphqlEndpointUrl()` Optional.
`String`	`getGraphqlSchema()` Optional.
`String`	`getGraphqlSchemaDisplayName()` Optional.
`Long`	`getId()` Output only.
`String`	`getImageUrl()` Optional.
`Long`	`getModified()` Output only.
`Boolean`	`getPublished()` Optional.
`Boolean`	`getRequireCallbackUrl()` Optional.
`String`	`getSiteId()` Output only.
`String`	`getSpecId()` Optional.
`String`	`getTitle()` Required.
`Boolean`	`getVisibility()` Optional.
`GoogleCloudApigeeV1ApiDoc`	`set(String fieldName, Object value)`
`GoogleCloudApigeeV1ApiDoc`	`setAnonAllowed(Boolean anonAllowed)` Optional.
`GoogleCloudApigeeV1ApiDoc`	`setApiProductName(String apiProductName)` Required.
`GoogleCloudApigeeV1ApiDoc`	`setCategoryIds(List<String> categoryIds)` Optional.
`GoogleCloudApigeeV1ApiDoc`	`setDescription(String description)` Optional.
`GoogleCloudApigeeV1ApiDoc`	`setEdgeAPIProductName(String edgeAPIProductName)` Optional.
`GoogleCloudApigeeV1ApiDoc`	`setGraphqlEndpointUrl(String graphqlEndpointUrl)` Optional.
`GoogleCloudApigeeV1ApiDoc`	`setGraphqlSchema(String graphqlSchema)` Optional.
`GoogleCloudApigeeV1ApiDoc`	`setGraphqlSchemaDisplayName(String graphqlSchemaDisplayName)` Optional.
`GoogleCloudApigeeV1ApiDoc`	`setId(Long id)` Output only.
`GoogleCloudApigeeV1ApiDoc`	`setImageUrl(String imageUrl)` Optional.
`GoogleCloudApigeeV1ApiDoc`	`setModified(Long modified)` Output only.
`GoogleCloudApigeeV1ApiDoc`	`setPublished(Boolean published)` Optional.
`GoogleCloudApigeeV1ApiDoc`	`setRequireCallbackUrl(Boolean requireCallbackUrl)` Optional.
`GoogleCloudApigeeV1ApiDoc`	`setSiteId(String siteId)` Output only.
`GoogleCloudApigeeV1ApiDoc`	`setSpecId(String specId)` Optional.
`GoogleCloudApigeeV1ApiDoc`	`setTitle(String title)` Required.
`GoogleCloudApigeeV1ApiDoc`	`setVisibility(Boolean visibility)` Optional.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudApigeeV1ApiDoc
```
public GoogleCloudApigeeV1ApiDoc()
```
- Method Detail
  - getAnonAllowed
```
public Boolean getAnonAllowed()
```
    Optional. Boolean flag that manages user access to the catalog item. When true, the catalog item has public visibility and can be viewed anonymously; otherwise, only registered users may view it. Note: when the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal- audience#enrolling_in_the_beta_release_of_the_audience_management_feature), and this flag is set to false, visibility is set to an indeterminate state and must be explicitly specified in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish- apis#visibility)). Additionally, when enrolled in the audience management feature, updates to this flag will be ignored as visibility permissions must be updated in the management UI.
    
    Returns:
    
    value or null for none
  - setAnonAllowed
```
public GoogleCloudApigeeV1ApiDoc setAnonAllowed(Boolean anonAllowed)
```
    Optional. Boolean flag that manages user access to the catalog item. When true, the catalog item has public visibility and can be viewed anonymously; otherwise, only registered users may view it. Note: when the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal- audience#enrolling_in_the_beta_release_of_the_audience_management_feature), and this flag is set to false, visibility is set to an indeterminate state and must be explicitly specified in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish- apis#visibility)). Additionally, when enrolled in the audience management feature, updates to this flag will be ignored as visibility permissions must be updated in the management UI.
    
    Parameters:
    
    anonAllowed - anonAllowed or null for none
  - getApiProductName
```
public String getApiProductName()
```
    Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
    
    Returns:
    
    value or null for none
  - setApiProductName
```
public GoogleCloudApigeeV1ApiDoc setApiProductName(String apiProductName)
```
    Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
    
    Parameters:
    
    apiProductName - apiProductName or null for none
  - getCategoryIds
```
public List<String> getCategoryIds()
```
    Optional. The IDs of the API categories to which this catalog item belongs.
    
    Returns:
    
    value or null for none
  - setCategoryIds
```
public GoogleCloudApigeeV1ApiDoc setCategoryIds(List<String> categoryIds)
```
    Optional. The IDs of the API categories to which this catalog item belongs.
    
    Parameters:
    
    categoryIds - categoryIds or null for none
  - getDescription
```
public String getDescription()
```
    Optional. Description of the catalog item. Max length is 10,000 characters.
    
    Returns:
    
    value or null for none
  - setDescription
```
public GoogleCloudApigeeV1ApiDoc setDescription(String description)
```
    Optional. Description of the catalog item. Max length is 10,000 characters.
    
    Parameters:
    
    description - description or null for none
  - getEdgeAPIProductName
```
public String getEdgeAPIProductName()
```
    Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
    
    Returns:
    
    value or null for none
  - setEdgeAPIProductName
```
public GoogleCloudApigeeV1ApiDoc setEdgeAPIProductName(String edgeAPIProductName)
```
    Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
    
    Parameters:
    
    edgeAPIProductName - edgeAPIProductName or null for none
  - getGraphqlEndpointUrl
```
public String getGraphqlEndpointUrl()
```
    Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    
    Returns:
    
    value or null for none
  - setGraphqlEndpointUrl
```
public GoogleCloudApigeeV1ApiDoc setGraphqlEndpointUrl(String graphqlEndpointUrl)
```
    Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    
    Parameters:
    
    graphqlEndpointUrl - graphqlEndpointUrl or null for none
  - getGraphqlSchema
```
public String getGraphqlSchema()
```
    Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    
    Returns:
    
    value or null for none
  - setGraphqlSchema
```
public GoogleCloudApigeeV1ApiDoc setGraphqlSchema(String graphqlSchema)
```
    Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    
    Parameters:
    
    graphqlSchema - graphqlSchema or null for none
  - getGraphqlSchemaDisplayName
```
public String getGraphqlSchemaDisplayName()
```
    Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    
    Returns:
    
    value or null for none
  - setGraphqlSchemaDisplayName
```
public GoogleCloudApigeeV1ApiDoc setGraphqlSchemaDisplayName(String graphqlSchemaDisplayName)
```
    Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
    
    Parameters:
    
    graphqlSchemaDisplayName - graphqlSchemaDisplayName or null for none
  - getId
```
public Long getId()
```
    Output only. The ID of the catalog item.
    
    Returns:
    
    value or null for none
  - setId
```
public GoogleCloudApigeeV1ApiDoc setId(Long id)
```
    Output only. The ID of the catalog item.
    
    Parameters:
    
    id - id or null for none
  - getImageUrl
```
public String getImageUrl()
```
    Optional. Location of the image used for the catalog item in the catalog. This can be either an image with an external URL or a file path for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files"), for example, `/files/book- tree.jpg`. When specifying the URL of an external image, the image won't be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
    
    Returns:
    
    value or null for none
  - setImageUrl
```
public GoogleCloudApigeeV1ApiDoc setImageUrl(String imageUrl)
```
    Optional. Location of the image used for the catalog item in the catalog. This can be either an image with an external URL or a file path for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files"), for example, `/files/book- tree.jpg`. When specifying the URL of an external image, the image won't be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
    
    Parameters:
    
    imageUrl - imageUrl or null for none
  - getModified
```
public Long getModified()
```
    Output only. Time the catalog item was last modified in milliseconds since epoch.
    
    Returns:
    
    value or null for none
  - setModified
```
public GoogleCloudApigeeV1ApiDoc setModified(Long modified)
```
    Output only. Time the catalog item was last modified in milliseconds since epoch.
    
    Parameters:
    
    modified - modified or null for none
  - getPublished
```
public Boolean getPublished()
```
    Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal- audience#enrolling_in_the_beta_release_of_the_audience_management_feature), the visibility can be set to public on creation by setting the anonAllowed flag to true or further managed in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish- apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
    
    Returns:
    
    value or null for none
  - setPublished
```
public GoogleCloudApigeeV1ApiDoc setPublished(Boolean published)
```
    Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal- audience#enrolling_in_the_beta_release_of_the_audience_management_feature), the visibility can be set to public on creation by setting the anonAllowed flag to true or further managed in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish- apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
    
    Parameters:
    
    published - published or null for none
  - getRequireCallbackUrl
```
public Boolean getRequireCallbackUrl()
```
    Optional. Whether a callback URL is required when this catalog item's API product is enabled in a developer app. When true, a portal user will be required to input a URL when managing the app (this is typically used for the app's OAuth flow).
    
    Returns:
    
    value or null for none
  - setRequireCallbackUrl
```
public GoogleCloudApigeeV1ApiDoc setRequireCallbackUrl(Boolean requireCallbackUrl)
```
    Optional. Whether a callback URL is required when this catalog item's API product is enabled in a developer app. When true, a portal user will be required to input a URL when managing the app (this is typically used for the app's OAuth flow).
    
    Parameters:
    
    requireCallbackUrl - requireCallbackUrl or null for none
  - getSiteId
```
public String getSiteId()
```
    Output only. The ID of the parent portal.
    
    Returns:
    
    value or null for none
  - setSiteId
```
public GoogleCloudApigeeV1ApiDoc setSiteId(String siteId)
```
    Output only. The ID of the parent portal.
    
    Parameters:
    
    siteId - siteId or null for none
  - getSpecId
```
public String getSpecId()
```
    Optional. DEPRECATED: DO NOT USE
    
    Returns:
    
    value or null for none
  - setSpecId
```
public GoogleCloudApigeeV1ApiDoc setSpecId(String specId)
```
    Optional. DEPRECATED: DO NOT USE
    
    Parameters:
    
    specId - specId or null for none
  - getTitle
```
public String getTitle()
```
    Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
    
    Returns:
    
    value or null for none
  - setTitle
```
public GoogleCloudApigeeV1ApiDoc setTitle(String title)
```
    Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.
    
    Parameters:
    
    title - title or null for none
  - getVisibility
```
public Boolean getVisibility()
```
    Optional. DEPRECATED: use the `published` field instead
    
    Returns:
    
    value or null for none
  - setVisibility
```
public GoogleCloudApigeeV1ApiDoc setVisibility(Boolean visibility)
```
    Optional. DEPRECATED: use the `published` field instead
    
    Parameters:
    
    visibility - visibility or null for none
  - set
```
public GoogleCloudApigeeV1ApiDoc set(String fieldName,
                                     Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudApigeeV1ApiDoc clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudApigeeV1ApiDoc

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudApigeeV1ApiDoc

Method Detail

getAnonAllowed

setAnonAllowed

getApiProductName

setApiProductName

getCategoryIds

setCategoryIds

getDescription

setDescription

getEdgeAPIProductName

setEdgeAPIProductName

getGraphqlEndpointUrl

setGraphqlEndpointUrl

getGraphqlSchema

setGraphqlSchema

getGraphqlSchemaDisplayName

setGraphqlSchemaDisplayName

getId

setId

getImageUrl

setImageUrl

getModified

setModified

getPublished

setPublished

getRequireCallbackUrl

setRequireCallbackUrl

getSiteId

setSiteId

getSpecId

setSpecId

getTitle

setTitle

getVisibility

setVisibility

set

clone