Documentation

Google_Service_Apigateway_Resource_ProjectsLocationsGateways extends Google_Service_Resource
in package

Application

The "gateways" collection of methods.

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

$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 Gateway in a given project and location. (gateways.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Apigateway_ApigatewayOperation: Deletes a single Gateway. (gateways.delete)
get() : Google_Service_Apigateway_ApigatewayGateway: Gets details of a single Gateway. (gateways.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. (gateways.getIamPolicy)
listProjectsLocationsGateways() : Google_Service_Apigateway_ApigatewayListGatewaysResponse: Lists Gateways in a given project and location.
patch() : Google_Service_Apigateway_ApigatewayOperation: Updates the parameters of a single Gateway. (gateways.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. (gateways.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

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

Return values

Google_Http_Request|expectedClass —

create()

Creates a new Gateway in a given project and location. (gateways.create)


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

Parameters

$parent : string: Required. Parent resource of the Gateway, of the form: projects/locations
$postBody : Google_Service_Apigateway_ApigatewayGateway
$optParams : array<string|int, mixed> = array(): Optional parameters.

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>

Return values

string —

$requestUrl

delete()

Deletes a single Gateway. (gateways.delete)


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

Parameters

$name : string: Required. Resource name of the form: projects/locations/gateways
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigateway_ApigatewayOperation —

get()

Gets details of a single Gateway. (gateways.get)


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

Parameters

$name : string: Required. Resource name of the form: projects/locations/gateways
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigateway_ApigatewayGateway —

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (gateways.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.

Return values

Google_Service_Apigateway_ApigatewayPolicy —

listProjectsLocationsGateways()

Lists Gateways in a given project and location.


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

(gateways.listProjectsLocationsGateways)

Parameters

$parent : string: Required. Parent resource of the Gateway, of the form: projects/locations
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigateway_ApigatewayListGatewaysResponse —

patch()

Updates the parameters of a single Gateway. (gateways.patch)


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

Parameters

$name : string: Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
$postBody : Google_Service_Apigateway_ApigatewayGateway
$optParams : array<string|int, mixed> = array(): Optional parameters.

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. (gateways.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. (gateways.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 —