Reference documentation and code samples for the Google Cloud Api Hub V1 Client class ApiHubCollectClient.
Service Description: This service exposes methods used for collecting various types of data from different first party and third party sources and push it to Hub's collect layer.
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 |
collectApiData
Collect API data from a source and push it to Hub's collect layer.
The async variant is ApiHubCollectClient::collectApiDataAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ApiHub\V1\CollectApiDataRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiHub\V1\ApiData;
use Google\Cloud\ApiHub\V1\Client\ApiHubCollectClient;
use Google\Cloud\ApiHub\V1\CollectApiDataRequest;
use Google\Cloud\ApiHub\V1\CollectApiDataResponse;
use Google\Cloud\ApiHub\V1\CollectionType;
use Google\Rpc\Status;
/**
* @param string $formattedLocation The regional location of the API hub instance and its resources.
* Format: `projects/{project}/locations/{location}`
* Please see {@see ApiHubCollectClient::locationName()} for help formatting this field.
* @param int $collectionType The type of collection. Applies to all entries in
* [api_data][google.cloud.apihub.v1.CollectApiDataRequest.api_data].
* @param string $formattedPluginInstance The plugin instance collecting the API data.
* Format:
* `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`. Please see
* {@see ApiHubCollectClient::pluginInstanceName()} for help formatting this field.
* @param string $actionId The action ID to be used for collecting the API data.
* This should map to one of the action IDs specified
* in action configs in the plugin.
*/
function collect_api_data_sample(
string $formattedLocation,
int $collectionType,
string $formattedPluginInstance,
string $actionId
): void {
// Create a client.
$apiHubCollectClient = new ApiHubCollectClient();
// Prepare the request message.
$apiData = new ApiData();
$request = (new CollectApiDataRequest())
->setLocation($formattedLocation)
->setCollectionType($collectionType)
->setPluginInstance($formattedPluginInstance)
->setActionId($actionId)
->setApiData($apiData);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $apiHubCollectClient->collectApiData($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var CollectApiDataResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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
{
$formattedLocation = ApiHubCollectClient::locationName('[PROJECT]', '[LOCATION]');
$collectionType = CollectionType::COLLECTION_TYPE_UNSPECIFIED;
$formattedPluginInstance = ApiHubCollectClient::pluginInstanceName(
'[PROJECT]',
'[LOCATION]',
'[PLUGIN]',
'[INSTANCE]'
);
$actionId = '[ACTION_ID]';
collect_api_data_sample($formattedLocation, $collectionType, $formattedPluginInstance, $actionId);
}
getLocation
Gets information about a location.
The async variant is ApiHubCollectClient::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\ApiHubCollectClient;
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.
$apiHubCollectClient = new ApiHubCollectClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $apiHubCollectClient->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 ApiHubCollectClient::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\ApiHubCollectClient;
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.
$apiHubCollectClient = new ApiHubCollectClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $apiHubCollectClient->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());
}
}
collectApiDataAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ApiHub\V1\CollectApiDataRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
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> |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\LongRunning\Client\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::apiName
Formats a string containing the fully-qualified path to represent a api resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
api |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted api resource. |
static::apiOperationName
Formats a string containing the fully-qualified path to represent a api_operation resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
api |
string
|
version |
string
|
operation |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted api_operation resource. |
static::attributeName
Formats a string containing the fully-qualified path to represent a attribute resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
attribute |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted attribute resource. |
static::definitionName
Formats a string containing the fully-qualified path to represent a definition resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
api |
string
|
version |
string
|
definition |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted definition resource. |
static::deploymentName
Formats a string containing the fully-qualified path to represent a deployment resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
deployment |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted deployment 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::pluginInstanceName
Formats a string containing the fully-qualified path to represent a plugin_instance resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
plugin |
string
|
instance |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted plugin_instance resource. |
static::specName
Formats a string containing the fully-qualified path to represent a spec resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
api |
string
|
version |
string
|
spec |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted spec resource. |
static::versionName
Formats a string containing the fully-qualified path to represent a version resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
api |
string
|
version |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted version 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
- api: projects/{project}/locations/{location}/apis/{api}
- apiOperation: projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
- attribute: projects/{project}/locations/{location}/attributes/{attribute}
- definition: projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
- deployment: projects/{project}/locations/{location}/deployments/{deployment}
- location: projects/{project}/locations/{location}
- pluginInstance: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
- spec: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
- version: projects/{project}/locations/{location}/apis/{api}/versions/{version}
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. |