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

OrganizationsSitesApicategories

class OrganizationsSitesApicategories extends Resource (View source)

The "apicategories" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $apicategories = $apigeeService->organizations_sites_apicategories;

Methods

GoogleCloudApigeeV1ApiCategoryResponse
create(string $parent, GoogleCloudApigeeV1ApiCategory $postBody, array $optParams = [])

Creates a new API category. (apicategories.create)

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

Deletes an API category. (apicategories.delete)

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

Gets an API category. (apicategories.get)

GoogleCloudApigeeV1ListApiCategoriesResponse
listOrganizationsSitesApicategories(string $parent, array $optParams = [])

Returns the API categories associated with a portal.

GoogleCloudApigeeV1ApiCategoryResponse
patch(string $name, GoogleCloudApigeeV1ApiCategory $postBody, array $optParams = [])

Updates an API category. (apicategories.patch)

Details

at line 45
GoogleCloudApigeeV1ApiCategoryResponse create(string $parent, GoogleCloudApigeeV1ApiCategory $postBody, array $optParams = [])

Creates a new API category. (apicategories.create)

Parameters

string $parent

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

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiCategoryResponse

Exceptions

Exception

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

Deletes an API category. (apicategories.delete)

Parameters

string $name

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

Optional parameters.

Return Value

GoogleCloudApigeeV1DeleteResponse

Exceptions

Exception

at line 77
GoogleCloudApigeeV1ApiCategoryResponse get(string $name, array $optParams = [])

Gets an API category. (apicategories.get)

Parameters

string $name

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

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiCategoryResponse

Exceptions

Exception

at line 93
GoogleCloudApigeeV1ListApiCategoriesResponse listOrganizationsSitesApicategories(string $parent, array $optParams = [])

Returns the API categories associated with a portal.

(apicategories.listOrganizationsSitesApicategories)

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

GoogleCloudApigeeV1ListApiCategoriesResponse

Exceptions

Exception

at line 110
GoogleCloudApigeeV1ApiCategoryResponse patch(string $name, GoogleCloudApigeeV1ApiCategory $postBody, array $optParams = [])

Updates an API category. (apicategories.patch)

Parameters

string $name

Required. Name of the category. Use the following structure in your request: organizations/{org}/sites/{site}/apicategories/{apicategory}
GoogleCloudApigeeV1ApiCategory $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiCategoryResponse

Exceptions

Exception