get($licenseCode, $project); * } finally { * $licenseCodesClient->close(); * } * ``` */ class LicenseCodesGapicClient { use GapicClientTrait; /** The name of the service. */ const SERVICE_NAME = 'google.cloud.compute.v1.LicenseCodes'; /** The default address of the service. */ const SERVICE_ADDRESS = 'compute.googleapis.com'; /** The default port of the service. */ const DEFAULT_SERVICE_PORT = 443; /** The name of the code generator, to be included in the agent header. */ const CODEGEN_NAME = 'gapic'; /** The default scopes required by the service. */ public static $serviceScopes = [ 'https://www.googleapis.com/auth/compute.readonly', 'https://www.googleapis.com/auth/compute', 'https://www.googleapis.com/auth/cloud-platform', ]; private static function getClientDefaults() { return [ 'serviceName' => self::SERVICE_NAME, 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, 'clientConfig' => __DIR__ . '/../resources/license_codes_client_config.json', 'descriptorsConfigPath' => __DIR__ . '/../resources/license_codes_descriptor_config.php', 'credentialsConfig' => [ 'defaultScopes' => self::$serviceScopes, 'useJwtAccessWithScope' => false, ], 'transportConfig' => [ 'rest' => [ 'restClientConfigPath' => __DIR__ . '/../resources/license_codes_rest_client_config.php', ], ], ]; } /** Implements GapicClientTrait::defaultTransport. */ private static function defaultTransport() { return 'rest'; } /** Implements GapicClientTrait::getSupportedTransports. */ private static function getSupportedTransports() { return [ 'rest', ]; } /** * Constructor. * * @param array $options { * Optional. Options for configuring the service API wrapper. * * @type string $apiEndpoint * The address of the API remote host. May optionally include the port, formatted * as ":". Default 'compute.googleapis.com:443'. * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials * 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 * {@see \Google\Auth\FetchAuthTokenInterface} object or * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these * objects are provided, any settings in $credentialsConfig will be ignored. * @type array $credentialsConfig * Options used to configure credentials, including auth token caching, for the * client. For a full list of supporting configuration options, see * {@see \Google\ApiCore\CredentialsWrapper::build()} . * @type bool $disableRetries * Determines whether or not retries defined by the client configuration should be * disabled. Defaults to `false`. * @type string|array $clientConfig * 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. * @type string|TransportInterface $transport * The transport used for executing network requests. At the moment, supports only * `rest`. *Advanced usage*: Additionally, it is possible to pass in an already * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note * that when this object is provided, any settings in $transportConfig, and any * $apiEndpoint setting, will be ignored. * @type array $transportConfig * 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 {@see \Google\ApiCore\Transport\RestTransport::build()} method for the * supported options. * @type callable $clientCertSource * 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. * } * * @throws ValidationException */ public function __construct(array $options = []) { $clientOptions = $this->buildClientOptions($options); $this->setClientOptions($clientOptions); } /** * Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. * * Sample code: * ``` * $licenseCodesClient = new LicenseCodesClient(); * try { * $licenseCode = 'license_code'; * $project = 'project'; * $response = $licenseCodesClient->get($licenseCode, $project); * } finally { * $licenseCodesClient->close(); * } * ``` * * @param string $licenseCode Number corresponding to the License code resource to return. * @param string $project Project ID for this request. * @param array $optionalArgs { * Optional. * * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on * {@see RetrySettings} for example usage. * } * * @return \Google\Cloud\Compute\V1\LicenseCode * * @throws ApiException if the remote call fails */ public function get($licenseCode, $project, array $optionalArgs = []) { $request = new GetLicenseCodeRequest(); $requestParamHeaders = []; $request->setLicenseCode($licenseCode); $request->setProject($project); $requestParamHeaders['license_code'] = $licenseCode; $requestParamHeaders['project'] = $project; $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders); $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader(); return $this->startCall('Get', LicenseCode::class, $optionalArgs, $request)->wait(); } /** * Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. * * Sample code: * ``` * $licenseCodesClient = new LicenseCodesClient(); * try { * $project = 'project'; * $resource = 'resource'; * $testPermissionsRequestResource = new TestPermissionsRequest(); * $response = $licenseCodesClient->testIamPermissions($project, $resource, $testPermissionsRequestResource); * } finally { * $licenseCodesClient->close(); * } * ``` * * @param string $project Project ID for this request. * @param string $resource Name or id of the resource for this request. * @param TestPermissionsRequest $testPermissionsRequestResource The body resource for this request * @param array $optionalArgs { * Optional. * * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on * {@see RetrySettings} for example usage. * } * * @return \Google\Cloud\Compute\V1\TestPermissionsResponse * * @throws ApiException if the remote call fails */ public function testIamPermissions($project, $resource, $testPermissionsRequestResource, array $optionalArgs = []) { $request = new TestIamPermissionsLicenseCodeRequest(); $requestParamHeaders = []; $request->setProject($project); $request->setResource($resource); $request->setTestPermissionsRequestResource($testPermissionsRequestResource); $requestParamHeaders['project'] = $project; $requestParamHeaders['resource'] = $resource; $requestParams = new RequestParamsHeaderDescriptor($requestParamHeaders); $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader(); return $this->startCall('TestIamPermissions', TestPermissionsResponse::class, $optionalArgs, $request)->wait(); } }