Audit Manager v1 API - Class StandardName (1.0.0-beta01) 

public sealed class StandardName : IResourceName, IEquatable<StandardName>

Reference documentation and code samples for the Audit Manager v1 API class StandardName.

Resource name for the Standard resource.

Inheritance

object > StandardName

Namespace

Google.Cloud.AuditManager.V1

Assembly

Google.Cloud.AuditManager.V1.dll

Constructors

StandardName(string, string, string)

public StandardName(string projectId, string locationId, string standardId)

Constructs a new instance of a StandardName class from the component parts of pattern projects/{project}/locations/{location}/standards/{standard}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
standardId string

The Standard ID. Must not be null or empty.

Properties

FolderId

public string FolderId { get; }

The Folder ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

The Location ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

StandardId

public string StandardId { get; }

The Standard ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public StandardName.ResourceNameType Type { get; }

The StandardName.ResourceNameType of the contained resource name.

Property Value
Type Description
StandardNameResourceNameType

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, string)

public static string Format(string projectId, string locationId, string standardId)

Formats the IDs into the string representation of this StandardName with pattern projects/{project}/locations/{location}/standards/{standard}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
standardId string

The Standard ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this StandardName with pattern projects/{project}/locations/{location}/standards/{standard}.

FormatFolderLocationStandard(string, string, string)

public static string FormatFolderLocationStandard(string folderId, string locationId, string standardId)

Formats the IDs into the string representation of this StandardName with pattern folders/{folder}/locations/{location}/standards/{standard}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
standardId string

The Standard ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this StandardName with pattern folders/{folder}/locations/{location}/standards/{standard}.

FormatOrganizationLocationStandard(string, string, string)

public static string FormatOrganizationLocationStandard(string organizationId, string locationId, string standardId)

Formats the IDs into the string representation of this StandardName with pattern organizations/{organization}/locations/{location}/standards/{standard}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
standardId string

The Standard ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this StandardName with pattern organizations/{organization}/locations/{location}/standards/{standard}.

FormatProjectLocationStandard(string, string, string)

public static string FormatProjectLocationStandard(string projectId, string locationId, string standardId)

Formats the IDs into the string representation of this StandardName with pattern projects/{project}/locations/{location}/standards/{standard}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
standardId string

The Standard ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this StandardName with pattern projects/{project}/locations/{location}/standards/{standard}.

FromFolderLocationStandard(string, string, string)

public static StandardName FromFolderLocationStandard(string folderId, string locationId, string standardId)

Creates a StandardName with the pattern folders/{folder}/locations/{location}/standards/{standard}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
standardId string

The Standard ID. Must not be null or empty.
Returns
Type Description
StandardName

A new instance of StandardName constructed from the provided ids.

FromOrganizationLocationStandard(string, string, string)

public static StandardName FromOrganizationLocationStandard(string organizationId, string locationId, string standardId)

Creates a StandardName with the pattern organizations/{organization}/locations/{location}/standards/{standard}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
standardId string

The Standard ID. Must not be null or empty.
Returns
Type Description
StandardName

A new instance of StandardName constructed from the provided ids.

FromProjectLocationStandard(string, string, string)

public static StandardName FromProjectLocationStandard(string projectId, string locationId, string standardId)

Creates a StandardName with the pattern projects/{project}/locations/{location}/standards/{standard}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
standardId string

The Standard ID. Must not be null or empty.
Returns
Type Description
StandardName

A new instance of StandardName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static StandardName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a StandardName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
StandardName

A new instance of StandardName 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 StandardName Parse(string standardName)

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

Parameter
Name Description
standardName string

The resource name in string form. Must not be null.
Returns
Type Description
StandardName

The parsed StandardName if successful.
Remarks

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

  • projects/{project}/locations/{location}/standards/{standard}
  • folders/{folder}/locations/{location}/standards/{standard}
  • organizations/{organization}/locations/{location}/standards/{standard}

Parse(string, bool)

public static StandardName Parse(string standardName, bool allowUnparsed)

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

Parameters
Name Description
standardName 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
StandardName

The parsed StandardName if successful.
Remarks

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

  • projects/{project}/locations/{location}/standards/{standard}
  • folders/{folder}/locations/{location}/standards/{standard}
  • organizations/{organization}/locations/{location}/standards/{standard}
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 StandardName)

public static bool TryParse(string standardName, out StandardName result)

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

Parameters
Name Description
standardName string

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

When this method returns, the parsed StandardName, 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}/locations/{location}/standards/{standard}
  • folders/{folder}/locations/{location}/standards/{standard}
  • organizations/{organization}/locations/{location}/standards/{standard}

TryParse(string, bool, out StandardName)

public static bool TryParse(string standardName, bool allowUnparsed, out StandardName result)

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

Parameters
Name Description
standardName 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 StandardName

When this method returns, the parsed StandardName, 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}/locations/{location}/standards/{standard}
  • folders/{folder}/locations/{location}/standards/{standard}
  • organizations/{organization}/locations/{location}/standards/{standard}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(StandardName, StandardName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a StandardName

The first resource name to compare, or null.
b StandardName

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 !=(StandardName, StandardName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a StandardName

The first resource name to compare, or null.
b StandardName

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.