Reference documentation and code samples for the Google Cloud Managed Identities V1 Client class ManagedIdentitiesServiceClient.
Service Description: API Overview
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ ManagedIdentities \ V1 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
attachTrust
Adds an AD trust to a domain.
The async variant is Google\Cloud\ManagedIdentities\V1\Client\BaseClient\self::attachTrustAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\AttachTrustRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
createMicrosoftAdDomain
Creates a Microsoft AD domain.
The async variant is Google\Cloud\ManagedIdentities\V1\Client\BaseClient\self::createMicrosoftAdDomainAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\CreateMicrosoftAdDomainRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
deleteDomain
Deletes a domain.
The async variant is Google\Cloud\ManagedIdentities\V1\Client\BaseClient\self::deleteDomainAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\DeleteDomainRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
detachTrust
Removes an AD trust.
The async variant is Google\Cloud\ManagedIdentities\V1\Client\BaseClient\self::detachTrustAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\DetachTrustRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
getDomain
Gets information about a domain.
The async variant is Google\Cloud\ManagedIdentities\V1\Client\BaseClient\self::getDomainAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\GetDomainRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\ManagedIdentities\V1\Domain |
listDomains
Lists domains in a project.
The async variant is Google\Cloud\ManagedIdentities\V1\Client\BaseClient\self::listDomainsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\ListDomainsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
reconfigureTrust
Updates the DNS conditional forwarder.
The async variant is Google\Cloud\ManagedIdentities\V1\Client\BaseClient\self::reconfigureTrustAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\ReconfigureTrustRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
resetAdminPassword
Resets a domain's administrator password.
The async variant is Google\Cloud\ManagedIdentities\V1\Client\BaseClient\self::resetAdminPasswordAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\ResetAdminPasswordRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\ManagedIdentities\V1\ResetAdminPasswordResponse |
updateDomain
Updates the metadata and configuration of a domain.
The async variant is Google\Cloud\ManagedIdentities\V1\Client\BaseClient\self::updateDomainAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\UpdateDomainRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
validateTrust
Validates a trust state, that the target domain is reachable, and that the target domain is able to accept incoming trust requests.
The async variant is Google\Cloud\ManagedIdentities\V1\Client\BaseClient\self::validateTrustAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\ValidateTrustRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
attachTrustAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\AttachTrustRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createMicrosoftAdDomainAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\CreateMicrosoftAdDomainRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteDomainAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\DeleteDomainRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
detachTrustAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\DetachTrustRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getDomainAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\GetDomainRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listDomainsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\ListDomainsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
reconfigureTrustAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\ReconfigureTrustRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
resetAdminPasswordAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\ResetAdminPasswordRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateDomainAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\UpdateDomainRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
validateTrustAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ManagedIdentities\V1\ValidateTrustRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\ApiCore\LongRunning\OperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
static::domainName
Formats a string containing the fully-qualified path to represent a domain resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
domain |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted domain resource. |
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted location resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- domain: projects/{project}/locations/{location}/domains/{domain}
- location: projects/{project}/locations/{location}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array | An associative array from name component IDs to component values. |