Google Cloud Security Command Center Settings v1beta1 API - Class ServiceAccountName (2.0.0-beta03)

public sealed class ServiceAccountName : IResourceName, IEquatable<ServiceAccountName>

Reference documentation and code samples for the Google Cloud Security Command Center Settings v1beta1 API class ServiceAccountName.

Resource name for the ServiceAccount resource.

Inheritance

object > ServiceAccountName

Namespace

Google.Cloud.SecurityCenter.Settings.V1Beta1

Assembly

Google.Cloud.SecurityCenter.Settings.V1Beta1.dll

Constructors

ServiceAccountName(string)

public ServiceAccountName(string organizationId)

Constructs a new instance of a ServiceAccountName class from the component parts of pattern organizations/{organization}/serviceAccount

Parameter
NameDescription
organizationIdstring

The Organization 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
TypeDescription
bool

OrganizationId

public string OrganizationId { get; }

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

Property Value
TypeDescription
string

Type

public ServiceAccountName.ResourceNameType Type { get; }

The ServiceAccountName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ServiceAccountNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string)

public static string Format(string organizationId)

Formats the IDs into the string representation of this ServiceAccountName with pattern organizations/{organization}/serviceAccount.

Parameter
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ServiceAccountName with pattern organizations/{organization}/serviceAccount.

FormatOrganization(string)

public static string FormatOrganization(string organizationId)

Formats the IDs into the string representation of this ServiceAccountName with pattern organizations/{organization}/serviceAccount.

Parameter
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ServiceAccountName with pattern organizations/{organization}/serviceAccount.

FromOrganization(string)

public static ServiceAccountName FromOrganization(string organizationId)

Creates a ServiceAccountName with the pattern organizations/{organization}/serviceAccount .

Parameter
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ServiceAccountName

A new instance of ServiceAccountName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static ServiceAccountName Parse(string serviceAccountName)

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

Parameter
NameDescription
serviceAccountNamestring

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

Returns
TypeDescription
ServiceAccountName

The parsed ServiceAccountName if successful.

Remarks

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

  • organizations/{organization}/serviceAccount

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
NameDescription
serviceAccountNamestring

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

allowUnparsedbool

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
TypeDescription
ServiceAccountName

The parsed ServiceAccountName if successful.

Remarks

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

  • organizations/{organization}/serviceAccount
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
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
NameDescription
serviceAccountNamestring

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

resultServiceAccountName

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

Returns
TypeDescription
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:

  • organizations/{organization}/serviceAccount

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
NameDescription
serviceAccountNamestring

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

allowUnparsedbool

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.

resultServiceAccountName

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

Returns
TypeDescription
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:

  • organizations/{organization}/serviceAccount
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
NameDescription
aServiceAccountName

The first resource name to compare, or null.

bServiceAccountName

The second resource name to compare, or null.

Returns
TypeDescription
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
NameDescription
aServiceAccountName

The first resource name to compare, or null.

bServiceAccountName

The second resource name to compare, or null.

Returns
TypeDescription
bool

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