Documentation

Google_Service_ServiceManagement_Resource_Services extends Google_Service_Resource
in package

Application

The "services" collection of methods.

Typical usage is: $servicemanagementService = new Google_Service_ServiceManagement(...); $services = $servicemanagementService->services;

$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_ServiceManagement_Operation: Creates a new managed service. A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion. One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project. Operation (services.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_ServiceManagement_Operation: Deletes a managed service. This method will change the service to the `Soft- Delete` state for 30 days. Within this period, service producers may call UndeleteService to restore the service. After 30 days, the service will be permanently deleted. Operation (services.delete)
enable() : Google_Service_ServiceManagement_Operation: Enables a service for a project, so it can be used for the project. See [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for more information. Operation (services.enable)
generateConfigReport() : Google_Service_ServiceManagement_GenerateConfigReportResponse: Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value If GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration. (services.generateConfigReport)
get() : Google_Service_ServiceManagement_ManagedService: Gets a managed service. Authentication is required unless the service is public. (services.get)
getConfig() : Google_Service_ServiceManagement_Service: Gets a service configuration (version) for a managed service.
getIamPolicy() : Google_Service_ServiceManagement_Policy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (services.getIamPolicy)
listServices() : Google_Service_ServiceManagement_ListServicesResponse: Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for. **BETA:** If the caller specifies the `consumer_id`, it returns only the services enabled on the consumer. The `consumer_id` must have the format of "project:{PROJECT-ID}".
setIamPolicy() : Google_Service_ServiceManagement_Policy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (services.setIamPolicy)
testIamPermissions() : Google_Service_ServiceManagement_TestIamPermissionsResponse: 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.
undelete() : Google_Service_ServiceManagement_Operation: Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days.
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 managed service. A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion. One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project. Operation (services.create)


    public
                create(Google_Service_ServiceManagement_ManagedService $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceManagement_Operation

Parameters

$postBody : Google_Service_ServiceManagement_ManagedService
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ServiceManagement_Operation —

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 managed service. This method will change the service to the `Soft- Delete` state for 30 days. Within this period, service producers may call UndeleteService to restore the service. After 30 days, the service will be permanently deleted. Operation (services.delete)


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

Parameters

$serviceName : string: Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ServiceManagement_Operation —

enable()

Enables a service for a project, so it can be used for the project. See [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for more information. Operation (services.enable)


    public
                enable(string $serviceName, Google_Service_ServiceManagement_EnableServiceRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceManagement_Operation

Parameters

$serviceName : string: Required. Name of the service to enable. Specifying an unknown service name will cause the request to fail.
$postBody : Google_Service_ServiceManagement_EnableServiceRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ServiceManagement_Operation —

generateConfigReport()

Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value If GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration. (services.generateConfigReport)


    public
                generateConfigReport(Google_Service_ServiceManagement_GenerateConfigReportRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceManagement_GenerateConfigReportResponse

Parameters

$postBody : Google_Service_ServiceManagement_GenerateConfigReportRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ServiceManagement_GenerateConfigReportResponse —

get()

Gets a managed service. Authentication is required unless the service is public. (services.get)


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

Parameters

$serviceName : string: Required. The name of the service. See the ServiceManager overview for naming requirements. For example: example.googleapis.com.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ServiceManagement_ManagedService —

getConfig()

Gets a service configuration (version) for a managed service.


    public
                getConfig(string $serviceName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceManagement_Service

(services.getConfig)

Parameters

$serviceName : string: Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ServiceManagement_Service —

getIamPolicy()

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


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

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_ServiceManagement_GetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ServiceManagement_Policy —

listServices()

Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for. **BETA:** If the caller specifies the `consumer_id`, it returns only the services enabled on the consumer. The `consumer_id` must have the format of "project:{PROJECT-ID}".


    public
                listServices([array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceManagement_ListServicesResponse

(services.listServices)

Parameters

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

Return values

Google_Service_ServiceManagement_ListServicesResponse —

setIamPolicy()

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


    public
                setIamPolicy(string $resource, Google_Service_ServiceManagement_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceManagement_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_ServiceManagement_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ServiceManagement_Policy —

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_ServiceManagement_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceManagement_TestIamPermissionsResponse

This operation may "fail open" without warning. (services.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_ServiceManagement_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ServiceManagement_TestIamPermissionsResponse —

undelete()

Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days.


    public
                undelete(string $serviceName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceManagement_Operation

Operation (services.undelete)

Parameters

$serviceName : string: Required. The name of the service. See the overview for naming requirements. For example: example.googleapis.com.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ServiceManagement_Operation —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —