com.google.api.services.apigee.v1

Class Apigee.Organizations.Sites.Apidocs

java.lang.Object

com.google.api.services.apigee.v1.Apigee.Organizations.Sites.Apidocs

Enclosing class:

Apigee.Organizations.Sites

public class Apigee.Organizations.Sites.Apidocs
extends Object

The "apidocs" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Sites.Apidocs.Create
class	Apigee.Organizations.Sites.Apidocs.Delete
class	Apigee.Organizations.Sites.Apidocs.Get
class	Apigee.Organizations.Sites.Apidocs.GetDocumentation
class	Apigee.Organizations.Sites.Apidocs.List
class	Apigee.Organizations.Sites.Apidocs.Update
class	Apigee.Organizations.Sites.Apidocs.UpdateDocumentation

Constructor Summary

Constructors

Constructor and Description
Apidocs()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Sites.Apidocs.Create	create(String parent, GoogleCloudApigeeV1ApiDoc content) Creates a new catalog item.
Apigee.Organizations.Sites.Apidocs.Delete	delete(String name) Deletes a catalog item.
Apigee.Organizations.Sites.Apidocs.Get	get(String name) Gets a catalog item.
Apigee.Organizations.Sites.Apidocs.GetDocumentation	getDocumentation(String name) Gets the documentation for the specified catalog item.
Apigee.Organizations.Sites.Apidocs.List	list(String parent) Returns the catalog items associated with a portal.
Apigee.Organizations.Sites.Apidocs.Update	update(String name, GoogleCloudApigeeV1ApiDoc content) Updates a catalog item.
Apigee.Organizations.Sites.Apidocs.UpdateDocumentation	updateDocumentation(String name, GoogleCloudApigeeV1ApiDocDocumentation content) Updates the documentation for the specified catalog item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Apidocs

public Apidocs()

Method Detail

create

public Apigee.Organizations.Sites.Apidocs.Create create(String parent,
                                                        GoogleCloudApigeeV1ApiDoc content)
                                                 throws IOException

Creates a new catalog item. Create a request for the method "apidocs.create". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}`

content - the GoogleCloudApigeeV1ApiDoc

Returns:

the request

Throws:

IOException

delete

public Apigee.Organizations.Sites.Apidocs.Delete delete(String name)
                                                 throws IOException

Deletes a catalog item. Create a request for the method "apidocs.delete". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}`

Returns:

the request

Throws:

IOException

get

public Apigee.Organizations.Sites.Apidocs.Get get(String name)
                                           throws IOException

Gets a catalog item. Create a request for the method "apidocs.get". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}`

Returns:

the request

Throws:

IOException

getDocumentation

public Apigee.Organizations.Sites.Apidocs.GetDocumentation getDocumentation(String name)
                                                                     throws IOException

Gets the documentation for the specified catalog item. Create a request for the method "apidocs.getDocumentation". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Resource name of the catalog item documentation. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation`

Returns:

the request

Throws:

IOException

list

public Apigee.Organizations.Sites.Apidocs.List list(String parent)
                                             throws IOException

Returns the catalog items associated with a portal. Create a request for the method "apidocs.list". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}`

Returns:

the request

Throws:

IOException

update

public Apigee.Organizations.Sites.Apidocs.Update update(String name,
                                                        GoogleCloudApigeeV1ApiDoc content)
                                                 throws IOException

Updates a catalog item. Create a request for the method "apidocs.update". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the catalog item. Use the following structure in your request: `organizations/{org}/sites/{site}/apidocs/{apidoc}`

content - the GoogleCloudApigeeV1ApiDoc

Returns:

the request

Throws:

IOException

updateDocumentation

public Apigee.Organizations.Sites.Apidocs.UpdateDocumentation updateDocumentation(String name,
                                                                                  GoogleCloudApigeeV1ApiDocDocumentation content)
                                                                           throws IOException

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 apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Returns:

the request

Throws:

IOException