Documentation

Google_Service_Apigee_Resource_OrganizationsEnvironmentsResourcefiles extends Google_Service_Resource
in package

The "resourcefiles" collection of methods.

Typical usage is: $apigeeService = new Google_Service_Apigee(...); $resourcefiles = $apigeeService->resourcefiles;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Apigee_GoogleCloudApigeeV1ResourceFile
Creates a resource file. Specify the `Content-Type` as `application/octet- stream` or `multipart/form-data`. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Apigee_GoogleCloudApigeeV1ResourceFile
Deletes a resource file. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).
get()  : Google_Service_Apigee_GoogleApiHttpBody
Gets the contents of a resource file. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).
listEnvironmentResources()  : Google_Service_Apigee_GoogleCloudApigeeV1ListEnvironmentResourcesResponse
Lists all resource files. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).
listOrganizationsEnvironmentsResourcefiles()  : Google_Service_Apigee_GoogleCloudApigeeV1ListEnvironmentResourcesResponse
Lists all resource files. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).
update()  : Google_Service_Apigee_GoogleCloudApigeeV1ResourceFile
Updates a resource file. Specify the `Content-Type` as `application/octet- stream` or `multipart/form-data`. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

Creates a resource file. Specify the `Content-Type` as `application/octet- stream` or `multipart/form-data`. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).

public create(string $parent, Google_Service_Apigee_GoogleApiHttpBody $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1ResourceFile

(resourcefiles.create)

Parameters
$parent : string

Required. Name of the environment in which to create the resource file in the following format: organizations/{org}/environments/{env}.

$postBody : Google_Service_Apigee_GoogleApiHttpBody
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string type Required. Resource file type. {{ resource_file_type }}

opt_param

string name Required. Name of the resource file. Must match the regular expression: [a-zA-Z0-9:/\!@#$%^&}[]()+-=,.~'` ]{1,255}

Return values
Google_Service_Apigee_GoogleCloudApigeeV1ResourceFile

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

Deletes a resource file. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).

public delete(string $parent, string $type, string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1ResourceFile

(resourcefiles.delete)

Parameters
$parent : string

Required. Name of the environment in the following format: organizations/{org}/environments/{env}.

$type : string

Required. Resource file type. {{ resource_file_type }}

$name : string

Required. ID of the resource file to delete. Must match the regular expression: [a-zA-Z0-9:/\!@#$%^&}[]()+-=,.~'` ]{1,255}

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1ResourceFile

get()

Gets the contents of a resource file. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).

public get(string $parent, string $type, string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleApiHttpBody

(resourcefiles.get)

Parameters
$parent : string

Required. Name of the environment in the following format: organizations/{org}/environments/{env}.

$type : string

Required. Resource file type. {{ resource_file_type }}

$name : string

Required. ID of the resource file. Must match the regular expression: [a-zA-Z0-9:/\!@#$%^&}[]()+-=,.~'` ]{1,255}

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleApiHttpBody

listEnvironmentResources()

Lists all resource files. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).

public listEnvironmentResources(string $parent, string $type[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1ListEnvironmentResourcesResponse

(resourcefiles.listEnvironmentResources)

Parameters
$parent : string

Required. Name of the environment in which to list resource files in the following format: organizations/{org}/environments/{env}.

$type : string

Optional. Type of resource files to list. {{ resource_file_type }}

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1ListEnvironmentResourcesResponse

listOrganizationsEnvironmentsResourcefiles()

Lists all resource files. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).

public listOrganizationsEnvironmentsResourcefiles(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1ListEnvironmentResourcesResponse

(resourcefiles.listOrganizationsEnvironmentsResourcefiles)

Parameters
$parent : string

Required. Name of the environment in which to list resource files in the following format: organizations/{org}/environments/{env}.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string type Optional. Type of resource files to list. {{ resource_file_type }}

Return values
Google_Service_Apigee_GoogleCloudApigeeV1ListEnvironmentResourcesResponse

update()

Updates a resource file. Specify the `Content-Type` as `application/octet- stream` or `multipart/form-data`. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).

public update(string $parent, string $type, string $name, Google_Service_Apigee_GoogleApiHttpBody $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1ResourceFile

(resourcefiles.update)

Parameters
$parent : string

Required. Name of the environment in the following format: organizations/{org}/environments/{env}.

$type : string

Required. Resource file type. {{ resource_file_type }}

$name : string

Required. ID of the resource file to update. Must match the regular expression: [a-zA-Z0-9:/\!@#$%^&}[]()+-=,.~'` ]{1,255}

$postBody : Google_Service_Apigee_GoogleApiHttpBody
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1ResourceFile

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results