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

public sealed class AuditReportName : IResourceName, IEquatable<AuditReportName>

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

Resource name for the AuditReport resource.

Inheritance

object > AuditReportName

Namespace

Google.Cloud.AuditManager.V1

Assembly

Google.Cloud.AuditManager.V1.dll

Constructors

AuditReportName(string, string, string)

public AuditReportName(string projectId, string locationId, string auditReportId)

Constructs a new instance of a AuditReportName class from the component parts of pattern projects/{project}/locations/{location}/auditReports/{audit_report}

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.
auditReportId string

The AuditReport ID. Must not be null or empty.

Properties

AuditReportId

public string AuditReportId { get; }

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

Property Value
Type Description
string

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

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

Type

public AuditReportName.ResourceNameType Type { get; }

The AuditReportName.ResourceNameType of the contained resource name.

Property Value
Type Description
AuditReportNameResourceNameType

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 auditReportId)

Formats the IDs into the string representation of this AuditReportName with pattern projects/{project}/locations/{location}/auditReports/{audit_report}.

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.
auditReportId string

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

The string representation of this AuditReportName with pattern projects/{project}/locations/{location}/auditReports/{audit_report}.

FormatFolderLocationAuditReport(string, string, string)

public static string FormatFolderLocationAuditReport(string folderId, string locationId, string auditReportId)

Formats the IDs into the string representation of this AuditReportName with pattern folders/{folder}/locations/{location}/auditReports/{audit_report}.

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.
auditReportId string

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

The string representation of this AuditReportName with pattern folders/{folder}/locations/{location}/auditReports/{audit_report}.

FormatProjectLocationAuditReport(string, string, string)

public static string FormatProjectLocationAuditReport(string projectId, string locationId, string auditReportId)

Formats the IDs into the string representation of this AuditReportName with pattern projects/{project}/locations/{location}/auditReports/{audit_report}.

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.
auditReportId string

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

The string representation of this AuditReportName with pattern projects/{project}/locations/{location}/auditReports/{audit_report}.

FromFolderLocationAuditReport(string, string, string)

public static AuditReportName FromFolderLocationAuditReport(string folderId, string locationId, string auditReportId)

Creates a AuditReportName with the pattern folders/{folder}/locations/{location}/auditReports/{audit_report}.

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.
auditReportId string

The AuditReport ID. Must not be null or empty.
Returns
Type Description
AuditReportName

A new instance of AuditReportName constructed from the provided ids.

FromProjectLocationAuditReport(string, string, string)

public static AuditReportName FromProjectLocationAuditReport(string projectId, string locationId, string auditReportId)

Creates a AuditReportName with the pattern projects/{project}/locations/{location}/auditReports/{audit_report}.

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.
auditReportId string

The AuditReport ID. Must not be null or empty.
Returns
Type Description
AuditReportName

A new instance of AuditReportName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AuditReportName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AuditReportName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
auditReportName string

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

The parsed AuditReportName if successful.
Remarks

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

  • projects/{project}/locations/{location}/auditReports/{audit_report}
  • folders/{folder}/locations/{location}/auditReports/{audit_report}

Parse(string, bool)

public static AuditReportName Parse(string auditReportName, bool allowUnparsed)

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

Parameters
Name Description
auditReportName 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
AuditReportName

The parsed AuditReportName if successful.
Remarks

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

  • projects/{project}/locations/{location}/auditReports/{audit_report}
  • folders/{folder}/locations/{location}/auditReports/{audit_report}
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 AuditReportName)

public static bool TryParse(string auditReportName, out AuditReportName result)

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

Parameters
Name Description
auditReportName string

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

When this method returns, the parsed AuditReportName, 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}/auditReports/{audit_report}
  • folders/{folder}/locations/{location}/auditReports/{audit_report}

TryParse(string, bool, out AuditReportName)

public static bool TryParse(string auditReportName, bool allowUnparsed, out AuditReportName result)

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

Parameters
Name Description
auditReportName 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 AuditReportName

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

Operators

operator ==(AuditReportName, AuditReportName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AuditReportName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AuditReportName

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

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.