UpdateMetadataInterface.php 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. <?php
  2. /*
  3. * Copyright 2020 Google LLC
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. namespace Google\Auth;
  18. /**
  19. * Describes a Credentials object which supports updating request metadata
  20. * (request headers).
  21. */
  22. interface UpdateMetadataInterface
  23. {
  24. const AUTH_METADATA_KEY = 'authorization';
  25. /**
  26. * Updates metadata with the authorization token.
  27. *
  28. * @param array<mixed> $metadata metadata hashmap
  29. * @param string $authUri optional auth uri
  30. * @param callable $httpHandler callback which delivers psr7 request
  31. * @return array<mixed> updated metadata hashmap
  32. */
  33. public function updateMetadata(
  34. $metadata,
  35. $authUri = null,
  36. callable $httpHandler = null
  37. );
  38. }