IAM Service Account Credentials v1 API - Class ServiceAccountName (2.3.0)

public sealed class ServiceAccountName : IResourceName, IEquatable<ServiceAccountName>

Reference documentation and code samples for the IAM Service Account Credentials v1 API class ServiceAccountName.

Resource name for the ServiceAccount resource.

Inheritance

object > ServiceAccountName

Namespace

Google.Cloud.Iam.Credentials.V1

Assembly

Google.Cloud.Iam.Credentials.V1.dll

Constructors

ServiceAccountName(string, string)

public ServiceAccountName(string projectId, string serviceAccountId)

Constructs a new instance of a ServiceAccountName class from the component parts of pattern projects/{project}/serviceAccounts/{service_account}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

serviceAccountId string

The ServiceAccount ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ServiceAccountId

public string ServiceAccountId { get; }

The ServiceAccount ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public ServiceAccountName.ResourceNameType Type { get; }

The ServiceAccountName.ResourceNameType of the contained resource name.

Property Value
Type Description
ServiceAccountNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string)

public static string Format(string projectId, string serviceAccountId)

Formats the IDs into the string representation of this ServiceAccountName with pattern projects/{project}/serviceAccounts/{service_account}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

serviceAccountId string

The ServiceAccount ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ServiceAccountName with pattern projects/{project}/serviceAccounts/{service_account}.

FormatProjectServiceAccount(string, string)

public static string FormatProjectServiceAccount(string projectId, string serviceAccountId)

Formats the IDs into the string representation of this ServiceAccountName with pattern projects/{project}/serviceAccounts/{service_account}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

serviceAccountId string

The ServiceAccount ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ServiceAccountName with pattern projects/{project}/serviceAccounts/{service_account}.

FromProjectServiceAccount(string, string)

public static ServiceAccountName FromProjectServiceAccount(string projectId, string serviceAccountId)

Creates a ServiceAccountName with the pattern projects/{project}/serviceAccounts/{service_account}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

serviceAccountId string

The ServiceAccount ID. Must not be null or empty.

Returns
Type Description
ServiceAccountName

A new instance of ServiceAccountName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ServiceAccountName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ServiceAccountName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ServiceAccountName

A new instance of ServiceAccountName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static ServiceAccountName Parse(string serviceAccountName)

Parses the given resource name string into a new ServiceAccountName instance.

Parameter
Name Description
serviceAccountName string

The resource name in string form. Must not be null.

Returns
Type Description
ServiceAccountName

The parsed ServiceAccountName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/serviceAccounts/{service_account}

Parse(string, bool)

public static ServiceAccountName Parse(string serviceAccountName, bool allowUnparsed)

Parses the given resource name string into a new ServiceAccountName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
serviceAccountName string

The resource name in string form. Must not be null.

allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
Type Description
ServiceAccountName

The parsed ServiceAccountName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/serviceAccounts/{service_account}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.

Overrides

TryParse(string, out ServiceAccountName)

public static bool TryParse(string serviceAccountName, out ServiceAccountName result)

Tries to parse the given resource name string into a new ServiceAccountName instance.

Parameters
Name Description
serviceAccountName string

The resource name in string form. Must not be null.

result ServiceAccountName

When this method returns, the parsed ServiceAccountName, or null if parsing failed.

Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/serviceAccounts/{service_account}

TryParse(string, bool, out ServiceAccountName)

public static bool TryParse(string serviceAccountName, bool allowUnparsed, out ServiceAccountName result)

Tries to parse the given resource name string into a new ServiceAccountName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
serviceAccountName string

The resource name in string form. Must not be null.

allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

result ServiceAccountName

When this method returns, the parsed ServiceAccountName, or null if parsing failed.

Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/serviceAccounts/{service_account}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ServiceAccountName, ServiceAccountName)

public static bool operator ==(ServiceAccountName a, ServiceAccountName b)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ServiceAccountName

The first resource name to compare, or null.

b ServiceAccountName

The second resource name to compare, or null.

Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(ServiceAccountName, ServiceAccountName)

public static bool operator !=(ServiceAccountName a, ServiceAccountName b)

Determines whether two specified resource names have different values.

Parameters
Name Description
a ServiceAccountName

The first resource name to compare, or null.

b ServiceAccountName

The second resource name to compare, or null.

Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.