-
Notifications
You must be signed in to change notification settings - Fork 30
Expand file tree
/
Copy pathCreatedHmacKey.php
More file actions
86 lines (80 loc) · 1.88 KB
/
CreatedHmacKey.php
File metadata and controls
86 lines (80 loc) · 1.88 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
<?php
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace Google\Cloud\Storage;
/**
* Represents a newly created HMAC key. Provides access to the key metadata and
* secret.
*
* Example:
* ```
* use Google\Cloud\Storage\StorageClient;
*
* $storage = new StorageClient();
* $response = $storage->createHmacKey($serviceAccountEmail);
* ```
*/
class CreatedHmacKey
{
/**
* @var HmacKey
*/
private $hmacKey;
/**
* @var string
*/
private $secret;
/**
* @param HmacKey $hmacKey The HMAC Key object.
* @param string $secret The HMAC key secret.
*/
public function __construct(HmacKey $hmacKey, $secret)
{
$this->hmacKey = $hmacKey;
$this->secret = $secret;
}
/**
* Get the HMAC key object.
*
* Example:
* ```
* $key = $response->hmacKey();
* ```
*
* @return HmacKey
*/
public function hmacKey()
{
return $this->hmacKey;
}
/**
* Get the HMAC key secret.
*
* This value will never be returned from the API after first creation. Make
* sure to record it for later use immediately upon key creation.
*
* Example:
* ```
* $secret = $response->secret();
* ```
*
* @return string
*/
public function secret()
{
return $this->secret;
}
}