Reference documentation and code samples for the Google Cloud Chronicle V1 Client class S3Auth.
Amazon S3 auth.
Generated from protobuf message google.cloud.chronicle.v1.S3Auth
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ access_key_id |
string
Access key ID. Used when using access key auth. |
↳ secret_access_key |
string
Secret access key. Used when using access key auth. |
↳ client_id |
string
Client ID. Used when using OAuth auth. |
↳ client_secret |
string
Client secret. Used when using OAuth auth. |
↳ refresh_uri |
string
Refresh URI. Used when using OAuth auth. |
↳ region |
int
S3 Region. |
getAccessKeyId
Access key ID. Used when using access key auth.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAccessKeyId
Access key ID. Used when using access key auth.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSecretAccessKey
Secret access key. Used when using access key auth.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSecretAccessKey
Secret access key. Used when using access key auth.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClientId
Client ID. Used when using OAuth auth.
| Returns | |
|---|---|
| Type | Description |
string |
|
setClientId
Client ID. Used when using OAuth auth.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClientSecret
Client secret. Used when using OAuth auth.
| Returns | |
|---|---|
| Type | Description |
string |
|
setClientSecret
Client secret. Used when using OAuth auth.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRefreshUri
Refresh URI. Used when using OAuth auth.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRefreshUri
Refresh URI. Used when using OAuth auth.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRegion
S3 Region.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type S3Region. |
setRegion
S3 Region.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type S3Region. |
| Returns | |
|---|---|
| Type | Description |
$this |
|