Reference documentation and code samples for the Google Cloud Workload Identity V1 Client class ServiceAgent.
Message describing ServiceAgent object
Generated from protobuf message google.cloud.workloadidentity.v1.ServiceAgent
Namespace
Google \ Cloud \ WorkloadIdentity \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The name of the service agent resource |
↳ container |
string
Optional. Name of the container that the service agent is associated with. For example: * * projects/1234 * * folders/1234 * * organizations/2344 |
↳ service_producer |
string
Optional. The service the agent belongs to. For example, bigquery.googleapis.com |
↳ principal |
string
Optional. The principal identifier for the service agent. This identifier is used in allow policies to grant access to the service agent. |
↳ role |
string
Optional. The role that should be granted to service agent on consumer project, if any. For example, "roles/aiplatform.serviceAgent". |
↳ state |
int
Output only. Service agent state. |
getName
Identifier. The name of the service agent resource
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The name of the service agent resource
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getContainer
Optional. Name of the container that the service agent is associated with.
For example:
- projects/1234
- folders/1234
- organizations/2344
| Returns | |
|---|---|
| Type | Description |
string |
|
setContainer
Optional. Name of the container that the service agent is associated with.
For example:
- projects/1234
- folders/1234
- organizations/2344
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceProducer
Optional. The service the agent belongs to.
For example, bigquery.googleapis.com
| Returns | |
|---|---|
| Type | Description |
string |
|
setServiceProducer
Optional. The service the agent belongs to.
For example, bigquery.googleapis.com
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrincipal
Optional. The principal identifier for the service agent. This identifier is used in allow policies to grant access to the service agent.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPrincipal
Optional. The principal identifier for the service agent. This identifier is used in allow policies to grant access to the service agent.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRole
Optional. The role that should be granted to service agent on consumer project, if any. For example, "roles/aiplatform.serviceAgent".
| Returns | |
|---|---|
| Type | Description |
string |
|
setRole
Optional. The role that should be granted to service agent on consumer project, if any. For example, "roles/aiplatform.serviceAgent".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. Service agent state.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. Service agent state.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|