Documentation

Google_Service_CloudRun_Resource_ProjectsLocationsServices extends Google_Service_Resource
in package

The "services" collection of methods.

Typical usage is: $runService = new Google_Service_CloudRun(...); $services = $runService->services;

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_CloudRun_Service
Create a service. (services.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudRun_Status
Delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions.
get()  : Google_Service_CloudRun_Service
Get information about a service. (services.get)
getIamPolicy()  : Google_Service_CloudRun_Policy
Get the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies.
listProjectsLocationsServices()  : Google_Service_CloudRun_ListServicesResponse
List services. (services.listProjectsLocationsServices)
replaceService()  : Google_Service_CloudRun_Service
Replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.
setIamPolicy()  : Google_Service_CloudRun_Policy
Sets the IAM Access control policy for the specified Service. Overwrites any existing policy. (services.setIamPolicy)
testIamPermissions()  : Google_Service_CloudRun_TestIamPermissionsResponse
Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call. (services.testIamPermissions)
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()

Create a service. (services.create)

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

The namespace in which the service should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number.

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

Optional parameters.

Return values
Google_Service_CloudRun_Service

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()

Delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions.

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

(services.delete)

Parameters
$name : string

The name of the service to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number.

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

Optional parameters.

Tags
opt_param

string apiVersion Cloud Run currently ignores this parameter.

opt_param

string propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers /garbage-collection/ for more information.

opt_param

string kind Cloud Run currently ignores this parameter.

Return values
Google_Service_CloudRun_Status

get()

Get information about a service. (services.get)

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

The name of the service to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number.

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

Optional parameters.

Return values
Google_Service_CloudRun_Service

getIamPolicy()

Get the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies.

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

(services.getIamPolicy)

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_CloudRun_Policy

listProjectsLocationsServices()

List services. (services.listProjectsLocationsServices)

public listProjectsLocationsServices(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudRun_ListServicesResponse
Parameters
$parent : string

The namespace from which the services should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number.

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

Optional parameters.

Tags
opt_param

string continue Optional encoded string to continue paging.

opt_param

string resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.

opt_param

string fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.

opt_param

bool includeUninitialized Not currently used by Cloud Run.

opt_param

int limit The maximum number of records that should be returned.

opt_param

string labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

opt_param

bool watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.

Return values
Google_Service_CloudRun_ListServicesResponse

replaceService()

Replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.

public replaceService(string $name, Google_Service_CloudRun_Service $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudRun_Service

(services.replaceService)

Parameters
$name : string

The name of the service being replaced. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number.

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

Optional parameters.

Return values
Google_Service_CloudRun_Service

setIamPolicy()

Sets the IAM Access control policy for the specified Service. Overwrites any existing policy. (services.setIamPolicy)

public setIamPolicy(string $resource, Google_Service_CloudRun_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudRun_Policy
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_CloudRun_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudRun_Policy

testIamPermissions()

Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call. (services.testIamPermissions)

public testIamPermissions(string $resource, Google_Service_CloudRun_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudRun_TestIamPermissionsResponse
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_CloudRun_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudRun_TestIamPermissionsResponse

convertToArrayAndStripNulls()

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

Search results