Documentation

Google_Service_Apigateway_Resource_ProjectsLocationsApisConfigs extends Google_Service_Resource
in package

The "configs" collection of methods.

Typical usage is: $apigatewayService = new Google_Service_Apigateway(...); $configs = $apigatewayService->configs;

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_Apigateway_ApigatewayOperation
Creates a new ApiConfig in a given project and location. (configs.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Apigateway_ApigatewayOperation
Deletes a single ApiConfig. (configs.delete)
get()  : Google_Service_Apigateway_ApigatewayApiConfig
Gets details of a single ApiConfig. (configs.get)
getIamPolicy()  : Google_Service_Apigateway_ApigatewayPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (configs.getIamPolicy)
listProjectsLocationsApisConfigs()  : Google_Service_Apigateway_ApigatewayListApiConfigsResponse
Lists ApiConfigs in a given project and location.
patch()  : Google_Service_Apigateway_ApigatewayOperation
Updates the parameters of a single ApiConfig. (configs.patch)
setIamPolicy()  : Google_Service_Apigateway_ApigatewayPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (configs.setIamPolicy)
testIamPermissions()  : Google_Service_Apigateway_ApigatewayTestIamPermissionsResponse
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.
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 new ApiConfig in a given project and location. (configs.create)

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

Required. Parent resource of the API Config, of the form: projects/locations/global/apis

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

Optional parameters.

Tags
opt_param

string apiConfigId Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource.

Return values
Google_Service_Apigateway_ApigatewayOperation —

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

get()

Gets details of a single ApiConfig. (configs.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigateway_ApigatewayApiConfig
Parameters
$name : string

Required. Resource name of the form: projects/locations/global/apis/configs

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

Optional parameters.

Tags
opt_param

string view Specifies which fields of the API Config are returned in the response. Defaults to BASIC view.

Return values
Google_Service_Apigateway_ApigatewayApiConfig —

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (configs.getIamPolicy)

public getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigateway_ApigatewayPolicy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

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

Optional parameters.

Tags
opt_param

int options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- policies).

Return values
Google_Service_Apigateway_ApigatewayPolicy —

listProjectsLocationsApisConfigs()

Lists ApiConfigs in a given project and location.

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

(configs.listProjectsLocationsApisConfigs)

Parameters
$parent : string

Required. Parent resource of the API Config, of the form: projects/locations/global/apis

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

Optional parameters.

Tags
opt_param

string pageToken Page token.

opt_param

string orderBy Order by parameters.

opt_param

string filter Filter.

opt_param

int pageSize Page size.

Return values
Google_Service_Apigateway_ApigatewayListApiConfigsResponse —

patch()

Updates the parameters of a single ApiConfig. (configs.patch)

public patch(string $name, Google_Service_Apigateway_ApigatewayApiConfig $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigateway_ApigatewayOperation
Parameters
$name : string

Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

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

Optional parameters.

Tags
opt_param

string updateMask Field mask is used to specify the fields to be overwritten in the ApiConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Return values
Google_Service_Apigateway_ApigatewayOperation —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (configs.setIamPolicy)

public setIamPolicy(string $resource, Google_Service_Apigateway_ApigatewaySetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigateway_ApigatewayPolicy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

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

Optional parameters.

Return values
Google_Service_Apigateway_ApigatewayPolicy —

testIamPermissions()

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

public testIamPermissions(string $resource, Google_Service_Apigateway_ApigatewayTestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigateway_ApigatewayTestIamPermissionsResponse

This operation may "fail open" without warning. (configs.testIamPermissions)

Parameters
$resource : string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

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

Optional parameters.

Return values
Google_Service_Apigateway_ApigatewayTestIamPermissionsResponse —

convertToArrayAndStripNulls()

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

Search results