1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Apigee
  7. \
  8. Resource
  9. \
  10. OrganizationsSitesApidocs

OrganizationsSitesApidocs

class OrganizationsSitesApidocs extends Resource (View source)

The "apidocs" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $apidocs = $apigeeService->organizations_sites_apidocs;

Methods

GoogleCloudApigeeV1ApiDocResponse
create(string $parent, GoogleCloudApigeeV1ApiDoc $postBody, array $optParams = [])

Creates a new catalog item. (apidocs.create)

GoogleCloudApigeeV1DeleteResponse
delete(string $name, array $optParams = [])

Deletes a catalog item. (apidocs.delete)

GoogleCloudApigeeV1ApiDocResponse
get(string $name, array $optParams = [])

Gets a catalog item. (apidocs.get)

GoogleCloudApigeeV1ApiDocDocumentationResponse
getDocumentation(string $name, array $optParams = [])

Gets the documentation for the specified catalog item.

GoogleCloudApigeeV1ListApiDocsResponse
listOrganizationsSitesApidocs(string $parent, array $optParams = [])

Returns the catalog items associated with a portal.

GoogleCloudApigeeV1ApiDocResponse
update(string $name, GoogleCloudApigeeV1ApiDoc $postBody, array $optParams = [])

Updates a catalog item. (apidocs.update)

GoogleCloudApigeeV1ApiDocDocumentationResponse
updateDocumentation(string $name, GoogleCloudApigeeV1ApiDocDocumentation $postBody, array $optParams = [])

Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.

Details

at line 47
GoogleCloudApigeeV1ApiDocResponse create(string $parent, GoogleCloudApigeeV1ApiDoc $postBody, array $optParams = [])

Creates a new catalog item. (apidocs.create)

Parameters

string $parent

Required. Name of the portal. Use the following structure in your request: organizations/{org}/sites/{site}
GoogleCloudApigeeV1ApiDoc $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiDocResponse

Exceptions

Exception

at line 63
GoogleCloudApigeeV1DeleteResponse delete(string $name, array $optParams = [])

Deletes a catalog item. (apidocs.delete)

Parameters

string $name

Required. Name of the catalog item. Use the following structure in your request: organizations/{org}/sites/{site}/apidocs/{apidoc}
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1DeleteResponse

Exceptions

Exception

at line 79
GoogleCloudApigeeV1ApiDocResponse get(string $name, array $optParams = [])

Gets a catalog item. (apidocs.get)

Parameters

string $name

Required. Name of the catalog item. Use the following structure in your request: organizations/{org}/sites/{site}/apidocs/{apidoc}
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiDocResponse

Exceptions

Exception

at line 96
GoogleCloudApigeeV1ApiDocDocumentationResponse getDocumentation(string $name, array $optParams = [])

Gets the documentation for the specified catalog item.

(apidocs.getDocumentation)

Parameters

string $name

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

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiDocDocumentationResponse

Exceptions

Exception

at line 119
GoogleCloudApigeeV1ListApiDocsResponse listOrganizationsSitesApidocs(string $parent, array $optParams = [])

Returns the catalog items associated with a portal.

(apidocs.listOrganizationsSitesApidocs)

Parameters

string $parent

Required. Name of the portal. Use the following structure in your request: organizations/{org}/sites/{site}
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListApiDocsResponse

Exceptions

Exception

at line 136
GoogleCloudApigeeV1ApiDocResponse update(string $name, GoogleCloudApigeeV1ApiDoc $postBody, array $optParams = [])

Updates a catalog item. (apidocs.update)

Parameters

string $name

Required. Name of the catalog item. Use the following structure in your request: organizations/{org}/sites/{site}/apidocs/{apidoc}
GoogleCloudApigeeV1ApiDoc $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiDocResponse

Exceptions

Exception

at line 155
GoogleCloudApigeeV1ApiDocDocumentationResponse updateDocumentation(string $name, GoogleCloudApigeeV1ApiDocDocumentation $postBody, array $optParams = [])

Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.

(apidocs.updateDocumentation)

Parameters

string $name

Required. Resource name of the catalog item documentation. Use the following structure in your request: organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation
GoogleCloudApigeeV1ApiDocDocumentation $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiDocDocumentationResponse

Exceptions

Exception