Reference documentation and code samples for the Google Cloud Api Hub V1 Client class ApiHubDiscoveryClient.
Service Description: This service exposes methods used to manage DiscoveredApiObservations and DiscoveredApiOperations.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ ApiHub \ 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. Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials |
↳ 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. At the moment, supports only |
↳ 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 = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method 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. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
getDiscoveredApiObservation
Gets a DiscoveredAPIObservation in a given project, location and ApiObservation.
The async variant is ApiHubDiscoveryClient::getDiscoveredApiObservationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ApiHub\V1\GetDiscoveredApiObservationRequest
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\ApiHub\V1\DiscoveredApiObservation |
use Google\ApiCore\ApiException;
use Google\Cloud\ApiHub\V1\Client\ApiHubDiscoveryClient;
use Google\Cloud\ApiHub\V1\DiscoveredApiObservation;
use Google\Cloud\ApiHub\V1\GetDiscoveredApiObservationRequest;
/**
* @param string $formattedName The name of the DiscoveredApiObservation to retrieve.
* Format:
* projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}
* Please see {@see ApiHubDiscoveryClient::discoveredApiObservationName()} for help formatting this field.
*/
function get_discovered_api_observation_sample(string $formattedName): void
{
// Create a client.
$apiHubDiscoveryClient = new ApiHubDiscoveryClient();
// Prepare the request message.
$request = (new GetDiscoveredApiObservationRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var DiscoveredApiObservation $response */
$response = $apiHubDiscoveryClient->getDiscoveredApiObservation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = ApiHubDiscoveryClient::discoveredApiObservationName(
'[PROJECT]',
'[LOCATION]',
'[DISCOVERED_API_OBSERVATION]'
);
get_discovered_api_observation_sample($formattedName);
}
getDiscoveredApiOperation
Gets a DiscoveredAPIOperation in a given project, location, ApiObservation and ApiOperation.
The async variant is ApiHubDiscoveryClient::getDiscoveredApiOperationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ApiHub\V1\GetDiscoveredApiOperationRequest
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\ApiHub\V1\DiscoveredApiOperation |
use Google\ApiCore\ApiException;
use Google\Cloud\ApiHub\V1\Client\ApiHubDiscoveryClient;
use Google\Cloud\ApiHub\V1\DiscoveredApiOperation;
use Google\Cloud\ApiHub\V1\GetDiscoveredApiOperationRequest;
/**
* @param string $formattedName The name of the DiscoveredApiOperation to retrieve.
* Format:
* projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}/discoveredApiOperations/{discovered_api_operation}
* Please see {@see ApiHubDiscoveryClient::discoveredApiOperationName()} for help formatting this field.
*/
function get_discovered_api_operation_sample(string $formattedName): void
{
// Create a client.
$apiHubDiscoveryClient = new ApiHubDiscoveryClient();
// Prepare the request message.
$request = (new GetDiscoveredApiOperationRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var DiscoveredApiOperation $response */
$response = $apiHubDiscoveryClient->getDiscoveredApiOperation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = ApiHubDiscoveryClient::discoveredApiOperationName(
'[PROJECT]',
'[LOCATION]',
'[DISCOVERED_API_OBSERVATION]',
'[DISCOVERED_API_OPERATION]'
);
get_discovered_api_operation_sample($formattedName);
}
listDiscoveredApiObservations
Lists all the DiscoveredAPIObservations in a given project and location.
The async variant is ApiHubDiscoveryClient::listDiscoveredApiObservationsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ApiHub\V1\ListDiscoveredApiObservationsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ApiHub\V1\Client\ApiHubDiscoveryClient;
use Google\Cloud\ApiHub\V1\ListDiscoveredApiObservationsRequest;
/**
* @param string $formattedParent The parent, which owns this collection of ApiObservations.
* Format:
* projects/{project}/locations/{location}
* Please see {@see ApiHubDiscoveryClient::locationName()} for help formatting this field.
*/
function list_discovered_api_observations_sample(string $formattedParent): void
{
// Create a client.
$apiHubDiscoveryClient = new ApiHubDiscoveryClient();
// Prepare the request message.
$request = (new ListDiscoveredApiObservationsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $apiHubDiscoveryClient->listDiscoveredApiObservations($request);
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = ApiHubDiscoveryClient::locationName('[PROJECT]', '[LOCATION]');
list_discovered_api_observations_sample($formattedParent);
}
listDiscoveredApiOperations
Lists all the DiscoveredAPIOperations in a given project, location and ApiObservation.
The async variant is ApiHubDiscoveryClient::listDiscoveredApiOperationsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ApiHub\V1\ListDiscoveredApiOperationsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ApiHub\V1\Client\ApiHubDiscoveryClient;
use Google\Cloud\ApiHub\V1\ListDiscoveredApiOperationsRequest;
/**
* @param string $formattedParent The parent, which owns this collection of
* DiscoveredApiOperations. Format:
* projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}
* Please see {@see ApiHubDiscoveryClient::discoveredApiObservationName()} for help formatting this field.
*/
function list_discovered_api_operations_sample(string $formattedParent): void
{
// Create a client.
$apiHubDiscoveryClient = new ApiHubDiscoveryClient();
// Prepare the request message.
$request = (new ListDiscoveredApiOperationsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $apiHubDiscoveryClient->listDiscoveredApiOperations($request);
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = ApiHubDiscoveryClient::discoveredApiObservationName(
'[PROJECT]',
'[LOCATION]',
'[DISCOVERED_API_OBSERVATION]'
);
list_discovered_api_operations_sample($formattedParent);
}
getLocation
Gets information about a location.
The async variant is ApiHubDiscoveryClient::getLocationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
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\Location\Location |
use Google\ApiCore\ApiException;
use Google\Cloud\ApiHub\V1\Client\ApiHubDiscoveryClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function get_location_sample(): void
{
// Create a client.
$apiHubDiscoveryClient = new ApiHubDiscoveryClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $apiHubDiscoveryClient->getLocation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
The async variant is ApiHubDiscoveryClient::listLocationsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ApiHub\V1\Client\ApiHubDiscoveryClient;
use Google\Cloud\Location\ListLocationsRequest;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function list_locations_sample(): void
{
// Create a client.
$apiHubDiscoveryClient = new ApiHubDiscoveryClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $apiHubDiscoveryClient->listLocations($request);
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getDiscoveredApiObservationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ApiHub\V1\GetDiscoveredApiObservationRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\ApiHub\V1\DiscoveredApiObservation> |
getDiscoveredApiOperationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ApiHub\V1\GetDiscoveredApiOperationRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\ApiHub\V1\DiscoveredApiOperation> |
listDiscoveredApiObservationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ApiHub\V1\ListDiscoveredApiObservationsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
listDiscoveredApiOperationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ApiHub\V1\ListDiscoveredApiOperationsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
getLocationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location> |
listLocationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
static::discoveredApiObservationName
Formats a string containing the fully-qualified path to represent a discovered_api_observation resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
discoveredApiObservation |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted discovered_api_observation resource. |
static::discoveredApiOperationName
Formats a string containing the fully-qualified path to represent a discovered_api_operation resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
discoveredApiObservation |
string
|
discoveredApiOperation |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted discovered_api_operation 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
- discoveredApiObservation: projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}
- discoveredApiOperation: projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}/discoveredApiOperations/{discovered_api_operation}
- 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. |