Interface ServiceAccountOrBuilder (3.50.0) 

public interface ServiceAccountOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

public abstract String getDescription()

Optional. A user-specified, human-readable description of the service account. The maximum length is 256 UTF-8 bytes.

string description = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. A user-specified, human-readable description of the service account. The maximum length is 256 UTF-8 bytes.

string description = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisabled()

public abstract boolean getDisabled()

Output only. Whether the service account is disabled.

bool disabled = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The disabled.

getDisplayName()

public abstract String getDisplayName()

Optional. A user-specified, human-readable name for the service account. The maximum length is 100 UTF-8 bytes.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. A user-specified, human-readable name for the service account. The maximum length is 100 UTF-8 bytes.

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

Returns
Type Description
ByteString

The bytes for displayName.

getEmail()

public abstract String getEmail()

Output only. The email address of the service account.

string email = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The email.

getEmailBytes()

public abstract ByteString getEmailBytes()

Output only. The email address of the service account.

string email = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for email.

getEtag() (deprecated)

public abstract ByteString getEtag()

Deprecated. google.iam.admin.v1.ServiceAccount.etag is deprecated. See google/iam/admin/v1/iam.proto;l=538

Deprecated. Do not use.

bytes etag = 7 [deprecated = true];

Returns
Type Description
ByteString

The etag.

getName()

public abstract String getName()

The resource name of the service account.

Use one of the following formats:

  • projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}

  • projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}

    As an alternative, you can use the - wildcard character instead of the project ID:

  • projects/-/serviceAccounts/{EMAIL_ADDRESS}

  • projects/-/serviceAccounts/{UNIQUE_ID}

    When possible, avoid using the - wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to get the service account projects/-/serviceAccounts/fake@example.com, which does not exist, the response contains an HTTP 403 Forbidden error instead of a 404 Not Found error.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The resource name of the service account.

Use one of the following formats:

  • projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}

  • projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}

    As an alternative, you can use the - wildcard character instead of the project ID:

  • projects/-/serviceAccounts/{EMAIL_ADDRESS}

  • projects/-/serviceAccounts/{UNIQUE_ID}

    When possible, avoid using the - wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to get the service account projects/-/serviceAccounts/fake@example.com, which does not exist, the response contains an HTTP 403 Forbidden error instead of a 404 Not Found error.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getOauth2ClientId()

public abstract String getOauth2ClientId()

Output only. The OAuth 2.0 client ID for the service account.

string oauth2_client_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The oauth2ClientId.

getOauth2ClientIdBytes()

public abstract ByteString getOauth2ClientIdBytes()

Output only. The OAuth 2.0 client ID for the service account.

string oauth2_client_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for oauth2ClientId.

getProjectId()

public abstract String getProjectId()

Output only. The ID of the project that owns the service account.

string project_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public abstract ByteString getProjectIdBytes()

Output only. The ID of the project that owns the service account.

string project_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for projectId.

getUniqueId()

public abstract String getUniqueId()

Output only. The unique, stable numeric ID for the service account.

Each service account retains its unique ID even if you delete the service account. For example, if you delete a service account, then create a new service account with the same name, the new service account has a different unique ID than the deleted service account.

string unique_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uniqueId.

getUniqueIdBytes()

public abstract ByteString getUniqueIdBytes()

Output only. The unique, stable numeric ID for the service account.

Each service account retains its unique ID even if you delete the service account. For example, if you delete a service account, then create a new service account with the same name, the new service account has a different unique ID than the deleted service account.

string unique_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uniqueId.