Documentation

Google_Service_ServiceRegistry_Resource_Endpoints extends Google_Service_Resource
in package

The "endpoints" collection of methods.

Typical usage is: $serviceregistryService = new Google_Service_ServiceRegistry(...); $endpoints = $serviceregistryService->endpoints;

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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_ServiceRegistry_Operation
Deletes an endpoint. (endpoints.delete)
get()  : Google_Service_ServiceRegistry_Endpoint
Gets an endpoint. (endpoints.get)
insert()  : Google_Service_ServiceRegistry_Operation
Creates an endpoint. (endpoints.insert)
listEndpoints()  : Google_Service_ServiceRegistry_EndpointsListResponse
Lists endpoints for a project. (endpoints.listEndpoints)
patch()  : Google_Service_ServiceRegistry_Operation
Updates an endpoint. This method supports patch semantics. (endpoints.patch)
update()  : Google_Service_ServiceRegistry_Operation
Updates an endpoint. (endpoints.update)
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 —

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 an endpoint. (endpoints.delete)

public delete(string $project, string $endpoint[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceRegistry_Operation
Parameters
$project : string

The project ID for this request.

$endpoint : string

The name of the endpoint for this request.

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

Optional parameters.

Return values
Google_Service_ServiceRegistry_Operation —

listEndpoints()

Lists endpoints for a project. (endpoints.listEndpoints)

public listEndpoints(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceRegistry_EndpointsListResponse
Parameters
$project : string

The project ID for this request.

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

Optional parameters.

Tags
opt_param

string filter Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example- instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

opt_param

string maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

opt_param

string orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

opt_param

string pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

Return values
Google_Service_ServiceRegistry_EndpointsListResponse —

patch()

Updates an endpoint. This method supports patch semantics. (endpoints.patch)

public patch(string $project, string $endpoint, Google_Service_ServiceRegistry_Endpoint $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceRegistry_Operation
Parameters
$project : string

The project ID for this request.

$endpoint : string

The name of the endpoint for this request.

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

Optional parameters.

Return values
Google_Service_ServiceRegistry_Operation —

update()

Updates an endpoint. (endpoints.update)

public update(string $project, string $endpoint, Google_Service_ServiceRegistry_Endpoint $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceRegistry_Operation
Parameters
$project : string

The project ID for this request.

$endpoint : string

The name of the endpoint for this request.

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

Optional parameters.

Return values
Google_Service_ServiceRegistry_Operation —

convertToArrayAndStripNulls()

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

Search results