Documentation

Google_Service_ServiceDirectory_Resource_ProjectsLocationsNamespacesServicesEndpoints extends Google_Service_Resource
in package

The "endpoints" collection of methods.

Typical usage is: $servicedirectoryService = new Google_Service_ServiceDirectory(...); $endpoints = $servicedirectoryService->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.
create()  : Google_Service_ServiceDirectory_Endpoint
Creates a endpoint, and returns the new Endpoint. (endpoints.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_ServiceDirectory_ServicedirectoryEmpty
Deletes a endpoint. (endpoints.delete)
get()  : Google_Service_ServiceDirectory_Endpoint
Gets a endpoint. (endpoints.get)
listProjectsLocationsNamespacesServicesEndpoints()  : Google_Service_ServiceDirectory_ListEndpointsResponse
Lists all endpoints.
patch()  : Google_Service_ServiceDirectory_Endpoint
Updates a endpoint. (endpoints.patch)
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 endpoint, and returns the new Endpoint. (endpoints.create)

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

Required. The resource name of the service that this endpoint provides.

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

Optional parameters.

Tags
opt_param

string endpointId Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Return values
Google_Service_ServiceDirectory_Endpoint —

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

listProjectsLocationsNamespacesServicesEndpoints()

Lists all endpoints.

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

(endpoints.listProjectsLocationsNamespacesServicesEndpoints)

Parameters
$parent : string

Required. The resource name of the service whose endpoints we'd like to list.

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

Optional parameters.

Tags
opt_param

int pageSize Optional. The maximum number of items to return.

opt_param

string filter Optional. The filter to list result by. General filter string syntax: () can be "name", "address", "port" or "metadata." for map field. can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and is roughly the same as "=". must be the same data type as field. can be "AND, OR, NOT". Examples of valid filters: * "metadata.owner" returns Endpoints that have a label with the key "owner" this is the same as "metadata:owner".

  • "metadata.protocol=gRPC" returns Endpoints that have key/value "protocol=gRPC". * "address=192.108.1.105" returns Endpoints that have this address. * "port>8080" returns Endpoints that have port number larger than
    • "name>projects/my-project/locations/us-east/namespaces/my- namespace/services/my-service/endpoints/endpoint-c" returns Endpoints that have name that is alphabetically later than the string, so "endpoint-e" will be returned but "endpoint-a" will not be. * "metadata.owner!=sd AND metadata.foo=bar" returns Endpoints that have "owner" in label key but value is not "sd" AND have key/value foo=bar. * "doesnotexist.foo=bar" returns an empty list. Note that Endpoint doesn't have a field called "doesnotexist". Since the filter does not match any Endpoints, it returns no results.
opt_param

string pageToken Optional. The next_page_token value returned from a previous List request, if any.

opt_param

string orderBy Optional. The order to list result by.

Return values
Google_Service_ServiceDirectory_ListEndpointsResponse —

patch()

Updates a endpoint. (endpoints.patch)

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

Immutable. The resource name for the endpoint in the format 'projects/locations/namespaces/services/endpoints'.

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

Optional parameters.

Tags
opt_param

string updateMask Required. List of fields to be updated in this request.

Return values
Google_Service_ServiceDirectory_Endpoint —

convertToArrayAndStripNulls()

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

Search results