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

public sealed class AuditScopeReportName : IResourceName, IEquatable<AuditScopeReportName>

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

Resource name for the AuditScopeReport resource.

Inheritance

object > AuditScopeReportName

Namespace

Google.Cloud.AuditManager.V1

Assembly

Google.Cloud.AuditManager.V1.dll

Constructors

AuditScopeReportName(string, string, string)

public AuditScopeReportName(string projectId, string locationId, string auditScopeReportId)

Constructs a new instance of a AuditScopeReportName class from the component parts of pattern projects/{project}/locations/{location}/auditScopeReports/{audit_scope_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.
auditScopeReportId string

The AuditScopeReport ID. Must not be null or empty.

Properties

AuditScopeReportId

public string AuditScopeReportId { get; }

The AuditScopeReport 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 AuditScopeReportName.ResourceNameType Type { get; }

The AuditScopeReportName.ResourceNameType of the contained resource name.

Property Value
Type Description
AuditScopeReportNameResourceNameType

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

Formats the IDs into the string representation of this AuditScopeReportName with pattern projects/{project}/locations/{location}/auditScopeReports/{audit_scope_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.
auditScopeReportId string

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

The string representation of this AuditScopeReportName with pattern projects/{project}/locations/{location}/auditScopeReports/{audit_scope_report}.

FormatFolderLocationAuditScopeReport(string, string, string)

public static string FormatFolderLocationAuditScopeReport(string folderId, string locationId, string auditScopeReportId)

Formats the IDs into the string representation of this AuditScopeReportName with pattern folders/{folder}/locations/{location}/auditScopeReports/{audit_scope_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.
auditScopeReportId string

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

The string representation of this AuditScopeReportName with pattern folders/{folder}/locations/{location}/auditScopeReports/{audit_scope_report}.

FormatProjectLocationAuditScopeReport(string, string, string)

public static string FormatProjectLocationAuditScopeReport(string projectId, string locationId, string auditScopeReportId)

Formats the IDs into the string representation of this AuditScopeReportName with pattern projects/{project}/locations/{location}/auditScopeReports/{audit_scope_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.
auditScopeReportId string

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

The string representation of this AuditScopeReportName with pattern projects/{project}/locations/{location}/auditScopeReports/{audit_scope_report}.

FromFolderLocationAuditScopeReport(string, string, string)

public static AuditScopeReportName FromFolderLocationAuditScopeReport(string folderId, string locationId, string auditScopeReportId)

Creates a AuditScopeReportName with the pattern folders/{folder}/locations/{location}/auditScopeReports/{audit_scope_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.
auditScopeReportId string

The AuditScopeReport ID. Must not be null or empty.
Returns
Type Description
AuditScopeReportName

A new instance of AuditScopeReportName constructed from the provided ids.

FromProjectLocationAuditScopeReport(string, string, string)

public static AuditScopeReportName FromProjectLocationAuditScopeReport(string projectId, string locationId, string auditScopeReportId)

Creates a AuditScopeReportName with the pattern projects/{project}/locations/{location}/auditScopeReports/{audit_scope_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.
auditScopeReportId string

The AuditScopeReport ID. Must not be null or empty.
Returns
Type Description
AuditScopeReportName

A new instance of AuditScopeReportName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AuditScopeReportName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AuditScopeReportName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
auditScopeReportName string

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

The parsed AuditScopeReportName if successful.
Remarks

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

  • projects/{project}/locations/{location}/auditScopeReports/{audit_scope_report}
  • folders/{folder}/locations/{location}/auditScopeReports/{audit_scope_report}

Parse(string, bool)

public static AuditScopeReportName Parse(string auditScopeReportName, bool allowUnparsed)

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

Parameters
Name Description
auditScopeReportName 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
AuditScopeReportName

The parsed AuditScopeReportName if successful.
Remarks

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

  • projects/{project}/locations/{location}/auditScopeReports/{audit_scope_report}
  • folders/{folder}/locations/{location}/auditScopeReports/{audit_scope_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 AuditScopeReportName)

public static bool TryParse(string auditScopeReportName, out AuditScopeReportName result)

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

Parameters
Name Description
auditScopeReportName string

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

When this method returns, the parsed AuditScopeReportName, 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}/auditScopeReports/{audit_scope_report}
  • folders/{folder}/locations/{location}/auditScopeReports/{audit_scope_report}

TryParse(string, bool, out AuditScopeReportName)

public static bool TryParse(string auditScopeReportName, bool allowUnparsed, out AuditScopeReportName result)

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

Parameters
Name Description
auditScopeReportName 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 AuditScopeReportName

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

Operators

operator ==(AuditScopeReportName, AuditScopeReportName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AuditScopeReportName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AuditScopeReportName

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

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.