0.2.0 (latest) 0.1.0 Reference documentation and code samples for the Workload Identity V1 API class Google::Cloud::WorkloadIdentity::V1::ServiceAgent.

Message describing ServiceAgent object

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #container

    def container() -> ::String

**Returns**

- (::String) --- Optional. Name of the container that the service agent is associated with.
  For example:

  - projects/1234
  - folders/1234
  - organizations/2344

### #container=

    def container=(value) -> ::String

**Parameter**

- **value** (::String) ---

  Optional. Name of the container that the service agent is associated with.
  For example:
  - projects/1234
  - folders/1234
  - organizations/2344
**Returns**

- (::String) --- Optional. Name of the container that the service agent is associated with.
  For example:

  - projects/1234
  - folders/1234
  - organizations/2344

### #name

    def name() -> ::String

**Returns**

- (::String) --- Identifier. The name of the service agent resource

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- Identifier. The name of the service agent resource
**Returns**

- (::String) --- Identifier. The name of the service agent resource

### #principal

    def principal() -> ::String

**Returns**

- (::String) --- Optional. The principal identifier for the service agent. This identifier is used in allow policies to grant access to the service agent.

### #principal=

    def principal=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The principal identifier for the service agent. This identifier is used in allow policies to grant access to the service agent.
**Returns**

- (::String) --- Optional. The principal identifier for the service agent. This identifier is used in allow policies to grant access to the service agent.

### #role

    def role() -> ::String

**Returns**

- (::String) --- Optional. The role that should be granted to service agent on consumer project, if any. For example, "roles/aiplatform.serviceAgent".

### #role=

    def role=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The role that should be granted to service agent on consumer project, if any. For example, "roles/aiplatform.serviceAgent".
**Returns**

- (::String) --- Optional. The role that should be granted to service agent on consumer project, if any. For example, "roles/aiplatform.serviceAgent".

### #service_producer

    def service_producer() -> ::String

**Returns**

- (::String) --- Optional. The service the agent belongs to. For example, bigquery.googleapis.com

### #service_producer=

    def service_producer=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The service the agent belongs to. For example, bigquery.googleapis.com
**Returns**

- (::String) --- Optional. The service the agent belongs to. For example, bigquery.googleapis.com

### #state

    def state() -> ::Google::Cloud::WorkloadIdentity::V1::ServiceAgent::State

**Returns**

- ([::Google::Cloud::WorkloadIdentity::V1::ServiceAgent::State](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-workload_identity-v1/latest/Google-Cloud-WorkloadIdentity-V1-ServiceAgent-State)) --- Output only. Service agent state.