Interface ServiceAgentOrBuilder (0.4.0)

public interface ServiceAgentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getContainer()

public abstract String getContainer()

Optional. Name of the container that the service agent is associated with. For example:

• projects/1234
• folders/1234
• organizations/2344

string container = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The container.

getContainerBytes()

public abstract ByteString getContainerBytes()

Optional. Name of the container that the service agent is associated with. For example:

• projects/1234
• folders/1234
• organizations/2344

string container = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for container.

getName()

public abstract String getName()

Identifier. The name of the service agent resource

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The name of the service agent resource

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getPrincipal()

public abstract String getPrincipal()

Optional. The principal identifier for the service agent. This identifier is used in allow policies to grant access to the service agent.

string principal = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The principal.

getPrincipalBytes()

public abstract ByteString getPrincipalBytes()

Optional. The principal identifier for the service agent. This identifier is used in allow policies to grant access to the service agent.

string principal = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for principal.

getRole()

public abstract String getRole()

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

string role = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The role.

getRoleBytes()

public abstract ByteString getRoleBytes()

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

string role = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for role.

getServiceProducer()

public abstract String getServiceProducer()

Optional. The service the agent belongs to. For example, bigquery.googleapis.com

string service_producer = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The serviceProducer.

getServiceProducerBytes()

public abstract ByteString getServiceProducerBytes()

Optional. The service the agent belongs to. For example, bigquery.googleapis.com

string service_producer = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for serviceProducer.

getState()

public abstract ServiceAgent.State getState()

Output only. Service agent state.

.google.cloud.workloadidentity.v1.ServiceAgent.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ServiceAgent.State	The state.

getStateValue()

public abstract int getStateValue()

Output only. Service agent state.

.google.cloud.workloadidentity.v1.ServiceAgent.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for state.