Documentation

Google_Service_ServiceDirectory_Resource_ProjectsLocationsNamespaces extends Google_Service_Resource
in package

The "namespaces" collection of methods.

Typical usage is: $servicedirectoryService = new Google_Service_ServiceDirectory(...); $namespaces = $servicedirectoryService->namespaces;

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_ServicedirectoryNamespace
Creates a namespace, and returns the new Namespace. (namespaces.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_ServiceDirectory_ServicedirectoryEmpty
Deletes a namespace. This also deletes all services and endpoints in the namespace. (namespaces.delete)
get()  : Google_Service_ServiceDirectory_ServicedirectoryNamespace
Gets a namespace. (namespaces.get)
getIamPolicy()  : Google_Service_ServiceDirectory_Policy
Gets the IAM Policy for a resource (namespace or service only).
listProjectsLocationsNamespaces()  : Google_Service_ServiceDirectory_ListNamespacesResponse
Lists all namespaces. (namespaces.listProjectsLocationsNamespaces)
patch()  : Google_Service_ServiceDirectory_ServicedirectoryNamespace
Updates a namespace. (namespaces.patch)
setIamPolicy()  : Google_Service_ServiceDirectory_Policy
Sets the IAM Policy for a resource (namespace or service only).
testIamPermissions()  : Google_Service_ServiceDirectory_TestIamPermissionsResponse
Tests IAM permissions for a resource (namespace or service only).
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 namespace, and returns the new Namespace. (namespaces.create)

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

Required. The resource name of the project and location the namespace will be created in.

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

Optional parameters.

Tags
opt_param

string namespaceId 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_ServicedirectoryNamespace —

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 a namespace. This also deletes all services and endpoints in the namespace. (namespaces.delete)

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

Required. The name of the namespace to delete.

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

Optional parameters.

Return values
Google_Service_ServiceDirectory_ServicedirectoryEmpty —

getIamPolicy()

Gets the IAM Policy for a resource (namespace or service only).

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

(namespaces.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.

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

Optional parameters.

Return values
Google_Service_ServiceDirectory_Policy —

listProjectsLocationsNamespaces()

Lists all namespaces. (namespaces.listProjectsLocationsNamespaces)

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

Required. The resource name of the project and location whose namespaces we'd like to list.

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

Optional parameters.

Tags
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. General order by string syntax: () (,) allows values {"name"} ascending or descending order by . If this is left blank, "asc" is used. Note that an empty order_by string result in default order, which is order by name in ascending order.

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", or "labels." 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: * "labels.owner" returns Namespaces that have a label with the key "owner" this is the same as "labels:owner". * "labels.protocol=gRPC" returns Namespaces that have key/value "protocol=gRPC". * "name>projects/my- project/locations/us-east/namespaces/namespace-c" returns Namespaces that have name that is alphabetically later than the string, so "namespace-e" will be returned but "namespace-a" will not be. * "labels.owner!=sd AND labels.foo=bar" returns Namespaces 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 Namespace doesn't have a field called "doesnotexist". Since the filter does not match any Namespaces, it returns no results.

Return values
Google_Service_ServiceDirectory_ListNamespacesResponse —

patch()

Updates a namespace. (namespaces.patch)

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

Immutable. The resource name for the namespace in the format 'projects/locations/namespaces'.

$postBody : Google_Service_ServiceDirectory_ServicedirectoryNamespace
$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_ServicedirectoryNamespace —

setIamPolicy()

Sets the IAM Policy for a resource (namespace or service only).

public setIamPolicy(string $resource, Google_Service_ServiceDirectory_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceDirectory_Policy

(namespaces.setIamPolicy)

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_ServiceDirectory_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_ServiceDirectory_Policy —

testIamPermissions()

Tests IAM permissions for a resource (namespace or service only).

public testIamPermissions(string $resource, Google_Service_ServiceDirectory_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ServiceDirectory_TestIamPermissionsResponse

(namespaces.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_ServiceDirectory_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_ServiceDirectory_TestIamPermissionsResponse —

convertToArrayAndStripNulls()

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

Search results