Apigee.Organizations.Sites.Apidocs.UpdateDocumentation (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.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.apigee.v1.ApigeeRequest<GoogleCloudApigeeV1ApiDocDocumentationResponse>
        
        com.google.api.services.apigee.v1.Apigee.Organizations.Sites.Apidocs.UpdateDocumentation

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: Apigee.Organizations.Sites.Apidocs

public class Apigee.Organizations.Sites.Apidocs.UpdateDocumentation
extends ApigeeRequest<GoogleCloudApigeeV1ApiDocDocumentationResponse>

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>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`UpdateDocumentation(String name, GoogleCloudApigeeV1ApiDocDocumentation content)` Updates the documentation for the specified catalog item.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getName()` Required.
`Apigee.Organizations.Sites.Apidocs.UpdateDocumentation`	`set(String parameterName, Object value)`
`Apigee.Organizations.Sites.Apidocs.UpdateDocumentation`	`set$Xgafv(String $Xgafv)` V1 error format.
`Apigee.Organizations.Sites.Apidocs.UpdateDocumentation`	`setAccessToken(String accessToken)` OAuth access token.
`Apigee.Organizations.Sites.Apidocs.UpdateDocumentation`	`setAlt(String alt)` Data format for response.
`Apigee.Organizations.Sites.Apidocs.UpdateDocumentation`	`setCallback(String callback)` JSONP
`Apigee.Organizations.Sites.Apidocs.UpdateDocumentation`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Apigee.Organizations.Sites.Apidocs.UpdateDocumentation`	`setKey(String key)` API key.
`Apigee.Organizations.Sites.Apidocs.UpdateDocumentation`	`setName(String name)` Required.
`Apigee.Organizations.Sites.Apidocs.UpdateDocumentation`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Apigee.Organizations.Sites.Apidocs.UpdateDocumentation`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Apigee.Organizations.Sites.Apidocs.UpdateDocumentation`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Apigee.Organizations.Sites.Apidocs.UpdateDocumentation`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Apigee.Organizations.Sites.Apidocs.UpdateDocumentation`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.apigee.v1.ApigeeRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

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
  - UpdateDocumentation
```
protected UpdateDocumentation(String name,
                              GoogleCloudApigeeV1ApiDocDocumentation content)
```
    Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message. Create a request for the method "apidocs.updateDocumentation". This request holds the parameters needed by the the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    UpdateDocumentation#initialize(com.google.api.client.googleapis.services. AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    name - Required. Resource name of the catalog item documentation. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation`
    
    content - the GoogleCloudApigeeV1ApiDocDocumentation
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Apigee.Organizations.Sites.Apidocs.UpdateDocumentation set$Xgafv(String $Xgafv)
```
    Description copied from class: ApigeeRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ApigeeRequest<GoogleCloudApigeeV1ApiDocDocumentationResponse>
  - setAccessToken
```
public Apigee.Organizations.Sites.Apidocs.UpdateDocumentation setAccessToken(String accessToken)
```
    Description copied from class: ApigeeRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ApigeeRequest<GoogleCloudApigeeV1ApiDocDocumentationResponse>
  - setAlt
```
public Apigee.Organizations.Sites.Apidocs.UpdateDocumentation setAlt(String alt)
```
    Description copied from class: ApigeeRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ApigeeRequest<GoogleCloudApigeeV1ApiDocDocumentationResponse>
  - setCallback
```
public Apigee.Organizations.Sites.Apidocs.UpdateDocumentation setCallback(String callback)
```
    Description copied from class: ApigeeRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ApigeeRequest<GoogleCloudApigeeV1ApiDocDocumentationResponse>
  - setFields
```
public Apigee.Organizations.Sites.Apidocs.UpdateDocumentation setFields(String fields)
```
    Description copied from class: ApigeeRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ApigeeRequest<GoogleCloudApigeeV1ApiDocDocumentationResponse>
  - setKey
```
public Apigee.Organizations.Sites.Apidocs.UpdateDocumentation setKey(String key)
```
    Description copied from class: ApigeeRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class ApigeeRequest<GoogleCloudApigeeV1ApiDocDocumentationResponse>
  - setOauthToken
```
public Apigee.Organizations.Sites.Apidocs.UpdateDocumentation setOauthToken(String oauthToken)
```
    Description copied from class: ApigeeRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ApigeeRequest<GoogleCloudApigeeV1ApiDocDocumentationResponse>
  - setPrettyPrint
```
public Apigee.Organizations.Sites.Apidocs.UpdateDocumentation setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ApigeeRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ApigeeRequest<GoogleCloudApigeeV1ApiDocDocumentationResponse>
  - setQuotaUser
```
public Apigee.Organizations.Sites.Apidocs.UpdateDocumentation setQuotaUser(String quotaUser)
```
    Description copied from class: ApigeeRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class ApigeeRequest<GoogleCloudApigeeV1ApiDocDocumentationResponse>
  - setUploadType
```
public Apigee.Organizations.Sites.Apidocs.UpdateDocumentation setUploadType(String uploadType)
```
    Description copied from class: ApigeeRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ApigeeRequest<GoogleCloudApigeeV1ApiDocDocumentationResponse>
  - setUploadProtocol
```
public Apigee.Organizations.Sites.Apidocs.UpdateDocumentation setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ApigeeRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ApigeeRequest<GoogleCloudApigeeV1ApiDocDocumentationResponse>
  - getName
```
public String getName()
```
    Required. Resource name of the catalog item documentation. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation`
  - setName
```
public Apigee.Organizations.Sites.Apidocs.UpdateDocumentation setName(String name)
```
    Required. Resource name of the catalog item documentation. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation`
  - set
```
public Apigee.Organizations.Sites.Apidocs.UpdateDocumentation set(String parameterName,
                                                                  Object value)
```
    Overrides:
    
    set in class ApigeeRequest<GoogleCloudApigeeV1ApiDocDocumentationResponse>

Class Apigee.Organizations.Sites.Apidocs.UpdateDocumentation

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

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.apigee.v1.ApigeeRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

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

UpdateDocumentation

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getName

setName

set