com.google.iam.admin.v1

Interface ServiceAccountOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ServiceAccount, ServiceAccount.Builder

public interface ServiceAccountOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
boolean	getDisabled() Output only.
String	getDisplayName() Optional.
com.google.protobuf.ByteString	getDisplayNameBytes() Optional.
String	getEmail() Output only.
com.google.protobuf.ByteString	getEmailBytes() Output only.
com.google.protobuf.ByteString	getEtag() Deprecated. google.iam.admin.v1.ServiceAccount.etag is deprecated. See google/iam/admin/v1/iam.proto;l=538
String	getName() The resource name of the service account.
com.google.protobuf.ByteString	getNameBytes() The resource name of the service account.
String	getOauth2ClientId() Output only.
com.google.protobuf.ByteString	getOauth2ClientIdBytes() Output only.
String	getProjectId() Output only.
com.google.protobuf.ByteString	getProjectIdBytes() Output only.
String	getUniqueId() Output only.
com.google.protobuf.ByteString	getUniqueIdBytes() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getProjectId

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:

The projectId.

getProjectIdBytes

com.google.protobuf.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:

The bytes for projectId.

getUniqueId

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:

The uniqueId.

getUniqueIdBytes

com.google.protobuf.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:

The bytes for uniqueId.

getEmail

String getEmail()

 Output only. The email address of the service account.
 

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

Returns:

The email.

getEmailBytes

com.google.protobuf.ByteString getEmailBytes()

 Output only. The email address of the service account.
 

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

Returns:

The bytes for email.

getDisplayName

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:

The displayName.

getDisplayNameBytes

com.google.protobuf.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:

The bytes for displayName.

getEtag

@Deprecated
com.google.protobuf.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:

The etag.

getDescription

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:

The description.

getDescriptionBytes

com.google.protobuf.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:

The bytes for description.

getOauth2ClientId

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:

The oauth2ClientId.

getOauth2ClientIdBytes

com.google.protobuf.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:

The bytes for oauth2ClientId.

getDisabled

boolean getDisabled()

 Output only. Whether the service account is disabled.
 

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

Returns:

The disabled.