Skip to content

Commit 8e899d0

Browse files
feat: [Many APIs] usage deprecation of credentials client option (#8596)
* feat: support ClientOptions in client constructor docs: document universeDomain client option docs: add "generic" phpdocs for OperationResponse and ServerStream fix: Update pagination rules for compute clients deps: Update dependency google/protobuf to v4 PiperOrigin-RevId: 807444648 Source-Link: googleapis/googleapis@6288882 Source-Link: googleapis/googleapis-gen@577eee9 Copy-Tag: eyJwIjoiQWNjZXNzQXBwcm92YWwvLk93bEJvdC55YW1sIiwiaCI6IjU3N2VlZTkzMWI3M2U5MTBmZmFlMWIxNzBmNmY5ZjhiZDc5NzVhMzYifQ== Copy-Tag: eyJwIjoiQWNjZXNzQ29udGV4dE1hbmFnZXIvLk93bEJvdC55YW1sIiwiaCI6IjU3N2VlZTkzMWI3M2U5MTBmZmFlMWIxNzBmNmY5ZjhiZDc5NzVhMzYifQ== Copy-Tag: eyJwIjoiQWRzQWRNYW5hZ2VyLy5Pd2xCb3QueWFtbCIsImgiOiI1NzdlZWU5MzFiNzNlOTEwZmZhZTFiMTcwZjZmOWY4YmQ3OTc1YTM2In0= Copy-Tag: eyJwIjoiQWRzTWFya2V0aW5nUGxhdGZvcm1BZG1pbi8uT3dsQm90LnlhbWwiLCJoIjoiNTc3ZWVlOTMxYjczZTkxMGZmYWUxYjE3MGY2ZjlmOGJkNzk3NWEzNiJ9 Copy-Tag: eyJwIjoiQWR2aXNvcnlOb3RpZmljYXRpb25zLy5Pd2xCb3QueWFtbCIsImgiOiI1NzdlZWU5MzFiNzNlOTEwZmZhZTFiMTcwZjZmOWY4YmQ3OTc1YTM2In0= Copy-Tag: eyJwIjoiQWlQbGF0Zm9ybS8uT3dsQm90LnlhbWwiLCJoIjoiNTc3ZWVlOTMxYjczZTkxMGZmYWUxYjE3MGY2ZjlmOGJkNzk3NWEzNiJ9 Copy-Tag: eyJwIjoiQWxsb3lEYi8uT3dsQm90LnlhbWwiLCJoIjoiNTc3ZWVlOTMxYjczZTkxMGZmYWUxYjE3MGY2ZjlmOGJkNzk3NWEzNiJ9 Copy-Tag: eyJwIjoiQW5hbHl0aWNzQWRtaW4vLk93bEJvdC55YW1sIiwiaCI6IjU3N2VlZTkzMWI3M2U5MTBmZmFlMWIxNzBmNmY5ZjhiZDc5NzVhMzYifQ== Copy-Tag: eyJwIjoiQW5hbHl0aWNzRGF0YS8uT3dsQm90LnlhbWwiLCJoIjoiNTc3ZWVlOTMxYjczZTkxMGZmYWUxYjE3MGY2ZjlmOGJkNzk3NWEzNiJ9 Copy-Tag: eyJwIjoiQXBpR2F0ZXdheS8uT3dsQm90LnlhbWwiLCJoIjoiNTc3ZWVlOTMxYjczZTkxMGZmYWUxYjE3MGY2ZjlmOGJkNzk3NWEzNiJ9 Copy-Tag: eyJwIjoiQXBpSHViLy5Pd2xCb3QueWFtbCIsImgiOiI1NzdlZWU5MzFiNzNlOTEwZmZhZTFiMTcwZjZmOWY4YmQ3OTc1YTM2In0= Copy-Tag: eyJwIjoiQXBpS2V5cy8uT3dsQm90LnlhbWwiLCJoIjoiNTc3ZWVlOTMxYjczZTkxMGZmYWUxYjE3MGY2ZjlmOGJkNzk3NWEzNiJ9 Copy-Tag: eyJwIjoiQXBpZ2VlQ29ubmVjdC8uT3dsQm90LnlhbWwiLCJoIjoiNTc3ZWVlOTMxYjczZTkxMGZmYWUxYjE3MGY2ZjlmOGJkNzk3NWEzNiJ9 Copy-Tag: eyJwIjoiQXBpZ2VlUmVnaXN0cnkvLk93bEJvdC55YW1sIiwiaCI6IjU3N2VlZTkzMWI3M2U5MTBmZmFlMWIxNzBmNmY5ZjhiZDc5NzVhMzYifQ== Copy-Tag: eyJwIjoiQXBwRW5naW5lQWRtaW4vLk93bEJvdC55YW1sIiwiaCI6IjU3N2VlZTkzMWI3M2U5MTBmZmFlMWIxNzBmNmY5ZjhiZDc5NzVhMzYifQ== Copy-Tag: eyJwIjoiQXBwSHViLy5Pd2xCb3QueWFtbCIsImgiOiI1NzdlZWU5MzFiNzNlOTEwZmZhZTFiMTcwZjZmOWY4YmQ3OTc1YTM2In0= Copy-Tag: eyJwIjoiQXBwc0NoYXQvLk93bEJvdC55YW1sIiwiaCI6IjU3N2VlZTkzMWI3M2U5MTBmZmFlMWIxNzBmNmY5ZjhiZDc5NzVhMzYifQ== Copy-Tag: eyJwIjoiQXBwc0V2ZW50c1N1YnNjcmlwdGlvbnMvLk93bEJvdC55YW1sIiwiaCI6IjU3N2VlZTkzMWI3M2U5MTBmZmFlMWIxNzBmNmY5ZjhiZDc5NzVhMzYifQ== Copy-Tag: eyJwIjoiQXBwc01lZXQvLk93bEJvdC55YW1sIiwiaCI6IjU3N2VlZTkzMWI3M2U5MTBmZmFlMWIxNzBmNmY5ZjhiZDc5NzVhMzYifQ== Copy-Tag: eyJwIjoiQXJ0aWZhY3RSZWdpc3RyeS8uT3dsQm90LnlhbWwiLCJoIjoiNTc3ZWVlOTMxYjczZTkxMGZmYWUxYjE3MGY2ZjlmOGJkNzk3NWEzNiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * docs: usage deprecation of credentials client option PiperOrigin-RevId: 809097824 Source-Link: googleapis/googleapis@e8ed6b4 Source-Link: googleapis/googleapis-gen@96cfee1 Copy-Tag: eyJwIjoiQWNjZXNzQXBwcm92YWwvLk93bEJvdC55YW1sIiwiaCI6Ijk2Y2ZlZTE2MzkzNjhlMzRhOGQxZjc2NWNlZGRlY2Y5ZGNhMTE5ZGMifQ== Copy-Tag: eyJwIjoiQWNjZXNzQ29udGV4dE1hbmFnZXIvLk93bEJvdC55YW1sIiwiaCI6Ijk2Y2ZlZTE2MzkzNjhlMzRhOGQxZjc2NWNlZGRlY2Y5ZGNhMTE5ZGMifQ== Copy-Tag: eyJwIjoiQWRzQWRNYW5hZ2VyLy5Pd2xCb3QueWFtbCIsImgiOiI5NmNmZWUxNjM5MzY4ZTM0YThkMWY3NjVjZWRkZWNmOWRjYTExOWRjIn0= Copy-Tag: eyJwIjoiQWRzTWFya2V0aW5nUGxhdGZvcm1BZG1pbi8uT3dsQm90LnlhbWwiLCJoIjoiOTZjZmVlMTYzOTM2OGUzNGE4ZDFmNzY1Y2VkZGVjZjlkY2ExMTlkYyJ9 Copy-Tag: eyJwIjoiQWR2aXNvcnlOb3RpZmljYXRpb25zLy5Pd2xCb3QueWFtbCIsImgiOiI5NmNmZWUxNjM5MzY4ZTM0YThkMWY3NjVjZWRkZWNmOWRjYTExOWRjIn0= Copy-Tag: eyJwIjoiQWlQbGF0Zm9ybS8uT3dsQm90LnlhbWwiLCJoIjoiOTZjZmVlMTYzOTM2OGUzNGE4ZDFmNzY1Y2VkZGVjZjlkY2ExMTlkYyJ9 Copy-Tag: eyJwIjoiQWxsb3lEYi8uT3dsQm90LnlhbWwiLCJoIjoiOTZjZmVlMTYzOTM2OGUzNGE4ZDFmNzY1Y2VkZGVjZjlkY2ExMTlkYyJ9 Copy-Tag: eyJwIjoiQW5hbHl0aWNzQWRtaW4vLk93bEJvdC55YW1sIiwiaCI6Ijk2Y2ZlZTE2MzkzNjhlMzRhOGQxZjc2NWNlZGRlY2Y5ZGNhMTE5ZGMifQ== Copy-Tag: eyJwIjoiQW5hbHl0aWNzRGF0YS8uT3dsQm90LnlhbWwiLCJoIjoiOTZjZmVlMTYzOTM2OGUzNGE4ZDFmNzY1Y2VkZGVjZjlkY2ExMTlkYyJ9 Copy-Tag: eyJwIjoiQXBpR2F0ZXdheS8uT3dsQm90LnlhbWwiLCJoIjoiOTZjZmVlMTYzOTM2OGUzNGE4ZDFmNzY1Y2VkZGVjZjlkY2ExMTlkYyJ9 Copy-Tag: eyJwIjoiQXBpSHViLy5Pd2xCb3QueWFtbCIsImgiOiI5NmNmZWUxNjM5MzY4ZTM0YThkMWY3NjVjZWRkZWNmOWRjYTExOWRjIn0= Copy-Tag: eyJwIjoiQXBpS2V5cy8uT3dsQm90LnlhbWwiLCJoIjoiOTZjZmVlMTYzOTM2OGUzNGE4ZDFmNzY1Y2VkZGVjZjlkY2ExMTlkYyJ9 Copy-Tag: eyJwIjoiQXBpZ2VlQ29ubmVjdC8uT3dsQm90LnlhbWwiLCJoIjoiOTZjZmVlMTYzOTM2OGUzNGE4ZDFmNzY1Y2VkZGVjZjlkY2ExMTlkYyJ9 Copy-Tag: eyJwIjoiQXBpZ2VlUmVnaXN0cnkvLk93bEJvdC55YW1sIiwiaCI6Ijk2Y2ZlZTE2MzkzNjhlMzRhOGQxZjc2NWNlZGRlY2Y5ZGNhMTE5ZGMifQ== Copy-Tag: eyJwIjoiQXBwRW5naW5lQWRtaW4vLk93bEJvdC55YW1sIiwiaCI6Ijk2Y2ZlZTE2MzkzNjhlMzRhOGQxZjc2NWNlZGRlY2Y5ZGNhMTE5ZGMifQ== Copy-Tag: eyJwIjoiQXBwSHViLy5Pd2xCb3QueWFtbCIsImgiOiI5NmNmZWUxNjM5MzY4ZTM0YThkMWY3NjVjZWRkZWNmOWRjYTExOWRjIn0= Copy-Tag: eyJwIjoiQXBwc0NoYXQvLk93bEJvdC55YW1sIiwiaCI6Ijk2Y2ZlZTE2MzkzNjhlMzRhOGQxZjc2NWNlZGRlY2Y5ZGNhMTE5ZGMifQ== Copy-Tag: eyJwIjoiQXBwc0V2ZW50c1N1YnNjcmlwdGlvbnMvLk93bEJvdC55YW1sIiwiaCI6Ijk2Y2ZlZTE2MzkzNjhlMzRhOGQxZjc2NWNlZGRlY2Y5ZGNhMTE5ZGMifQ== Copy-Tag: eyJwIjoiQXBwc01lZXQvLk93bEJvdC55YW1sIiwiaCI6Ijk2Y2ZlZTE2MzkzNjhlMzRhOGQxZjc2NWNlZGRlY2Y5ZGNhMTE5ZGMifQ== Copy-Tag: eyJwIjoiQXJ0aWZhY3RSZWdpc3RyeS8uT3dsQm90LnlhbWwiLCJoIjoiOTZjZmVlMTYzOTM2OGUzNGE4ZDFmNzY1Y2VkZGVjZjlkY2ExMTlkYyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 6d007ac commit 8e899d0

98 files changed

Lines changed: 3650 additions & 4041 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

AccessApproval/src/V1/Client/AccessApprovalClient.php

Lines changed: 40 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
use Google\ApiCore\ApiException;
2828
use Google\ApiCore\CredentialsWrapper;
2929
use Google\ApiCore\GapicClientTrait;
30+
use Google\ApiCore\Options\ClientOptions;
3031
use Google\ApiCore\PagedListResponse;
3132
use Google\ApiCore\ResourceHelperTrait;
3233
use Google\ApiCore\RetrySettings;
@@ -126,7 +127,9 @@ final class AccessApprovalClient
126127
private const CODEGEN_NAME = 'gapic';
127128

128129
/** The default scopes required by the service. */
129-
public static $serviceScopes = ['https://www.googleapis.com/auth/cloud-platform'];
130+
public static $serviceScopes = [
131+
'https://www.googleapis.com/auth/cloud-platform',
132+
];
130133

131134
private static function getClientDefaults()
132135
{
@@ -357,25 +360,28 @@ public static function parseName(string $formattedName, ?string $template = null
357360
/**
358361
* Constructor.
359362
*
360-
* @param array $options {
363+
* @param array|ClientOptions $options {
361364
* Optional. Options for configuring the service API wrapper.
362365
*
363366
* @type string $apiEndpoint
364367
* The address of the API remote host. May optionally include the port, formatted
365368
* as "<uri>:<port>". Default 'accessapproval.googleapis.com:443'.
366-
* @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials
367-
* The credentials to be used by the client to authorize API calls. This option
368-
* accepts either a path to a credentials file, or a decoded credentials file as a
369-
* PHP array.
370-
* *Advanced usage*: In addition, this option can also accept a pre-constructed
371-
* {@see \Google\Auth\FetchAuthTokenInterface} object or
372-
* {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these
373-
* objects are provided, any settings in $credentialsConfig will be ignored.
374-
* *Important*: If you accept a credential configuration (credential
375-
* JSON/File/Stream) from an external source for authentication to Google Cloud
376-
* Platform, you must validate it before providing it to any Google API or library.
377-
* Providing an unvalidated credential configuration to Google APIs can compromise
378-
* the security of your systems and data. For more information {@see
369+
* @type FetchAuthTokenInterface|CredentialsWrapper $credentials
370+
* This option should only be used with a pre-constructed
371+
* {@see FetchAuthTokenInterface} or {@see CredentialsWrapper} object. Note that
372+
* when one of these objects are provided, any settings in $credentialsConfig will
373+
* be ignored.
374+
* **Important**: If you are providing a path to a credentials file, or a decoded
375+
* credentials file as a PHP array, this usage is now DEPRECATED. Providing an
376+
* unvalidated credential configuration to Google APIs can compromise the security
377+
* of your systems and data. It is recommended to create the credentials explicitly
378+
* ```
379+
* use Google\Auth\Credentials\ServiceAccountCredentials;
380+
* use Google\Cloud\AccessApproval\V1\AccessApprovalClient;
381+
* $creds = new ServiceAccountCredentials($scopes, $json);
382+
* $options = new AccessApprovalClient(['credentials' => $creds]);
383+
* ```
384+
* {@see
379385
* https://cloud.google.com/docs/authentication/external/externally-sourced-credentials}
380386
* @type array $credentialsConfig
381387
* Options used to configure credentials, including auth token caching, for the
@@ -413,11 +419,13 @@ public static function parseName(string $formattedName, ?string $template = null
413419
* @type false|LoggerInterface $logger
414420
* A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
415421
* 'GOOGLE_SDK_PHP_LOGGING' environment flag
422+
* @type string $universeDomain
423+
* The service domain for the client. Defaults to 'googleapis.com'.
416424
* }
417425
*
418426
* @throws ValidationException
419427
*/
420-
public function __construct(array $options = [])
428+
public function __construct(array|ClientOptions $options = [])
421429
{
422430
$clientOptions = $this->buildClientOptions($options);
423431
$this->setClientOptions($clientOptions);
@@ -459,10 +467,8 @@ public function __call($method, $args)
459467
*
460468
* @throws ApiException Thrown if the API call fails.
461469
*/
462-
public function approveApprovalRequest(
463-
ApproveApprovalRequestMessage $request,
464-
array $callOptions = []
465-
): ApprovalRequest {
470+
public function approveApprovalRequest(ApproveApprovalRequestMessage $request, array $callOptions = []): ApprovalRequest
471+
{
466472
return $this->startApiCall('ApproveApprovalRequest', $request, $callOptions)->wait();
467473
}
468474

@@ -491,10 +497,8 @@ public function approveApprovalRequest(
491497
*
492498
* @throws ApiException Thrown if the API call fails.
493499
*/
494-
public function deleteAccessApprovalSettings(
495-
DeleteAccessApprovalSettingsMessage $request,
496-
array $callOptions = []
497-
): void {
500+
public function deleteAccessApprovalSettings(DeleteAccessApprovalSettingsMessage $request, array $callOptions = []): void
501+
{
498502
$this->startApiCall('DeleteAccessApprovalSettings', $request, $callOptions)->wait();
499503
}
500504

@@ -529,10 +533,8 @@ public function deleteAccessApprovalSettings(
529533
*
530534
* @throws ApiException Thrown if the API call fails.
531535
*/
532-
public function dismissApprovalRequest(
533-
DismissApprovalRequestMessage $request,
534-
array $callOptions = []
535-
): ApprovalRequest {
536+
public function dismissApprovalRequest(DismissApprovalRequestMessage $request, array $callOptions = []): ApprovalRequest
537+
{
536538
return $this->startApiCall('DismissApprovalRequest', $request, $callOptions)->wait();
537539
}
538540

@@ -559,10 +561,8 @@ public function dismissApprovalRequest(
559561
*
560562
* @throws ApiException Thrown if the API call fails.
561563
*/
562-
public function getAccessApprovalServiceAccount(
563-
GetAccessApprovalServiceAccountMessage $request,
564-
array $callOptions = []
565-
): AccessApprovalServiceAccount {
564+
public function getAccessApprovalServiceAccount(GetAccessApprovalServiceAccountMessage $request, array $callOptions = []): AccessApprovalServiceAccount
565+
{
566566
return $this->startApiCall('GetAccessApprovalServiceAccount', $request, $callOptions)->wait();
567567
}
568568

@@ -588,10 +588,8 @@ public function getAccessApprovalServiceAccount(
588588
*
589589
* @throws ApiException Thrown if the API call fails.
590590
*/
591-
public function getAccessApprovalSettings(
592-
GetAccessApprovalSettingsMessage $request,
593-
array $callOptions = []
594-
): AccessApprovalSettings {
591+
public function getAccessApprovalSettings(GetAccessApprovalSettingsMessage $request, array $callOptions = []): AccessApprovalSettings
592+
{
595593
return $this->startApiCall('GetAccessApprovalSettings', $request, $callOptions)->wait();
596594
}
597595

@@ -650,10 +648,8 @@ public function getApprovalRequest(GetApprovalRequestMessage $request, array $ca
650648
*
651649
* @throws ApiException Thrown if the API call fails.
652650
*/
653-
public function invalidateApprovalRequest(
654-
InvalidateApprovalRequestMessage $request,
655-
array $callOptions = []
656-
): ApprovalRequest {
651+
public function invalidateApprovalRequest(InvalidateApprovalRequestMessage $request, array $callOptions = []): ApprovalRequest
652+
{
657653
return $this->startApiCall('InvalidateApprovalRequest', $request, $callOptions)->wait();
658654
}
659655

@@ -680,10 +676,8 @@ public function invalidateApprovalRequest(
680676
*
681677
* @throws ApiException Thrown if the API call fails.
682678
*/
683-
public function listApprovalRequests(
684-
ListApprovalRequestsMessage $request,
685-
array $callOptions = []
686-
): PagedListResponse {
679+
public function listApprovalRequests(ListApprovalRequestsMessage $request, array $callOptions = []): PagedListResponse
680+
{
687681
return $this->startApiCall('ListApprovalRequests', $request, $callOptions);
688682
}
689683

@@ -710,10 +704,8 @@ public function listApprovalRequests(
710704
*
711705
* @throws ApiException Thrown if the API call fails.
712706
*/
713-
public function updateAccessApprovalSettings(
714-
UpdateAccessApprovalSettingsMessage $request,
715-
array $callOptions = []
716-
): AccessApprovalSettings {
707+
public function updateAccessApprovalSettings(UpdateAccessApprovalSettingsMessage $request, array $callOptions = []): AccessApprovalSettings
708+
{
717709
return $this->startApiCall('UpdateAccessApprovalSettings', $request, $callOptions)->wait();
718710
}
719711
}

0 commit comments

Comments
 (0)