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

public sealed class EnrollmentStatusScopeName : IResourceName, IEquatable<EnrollmentStatusScopeName>

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

Resource name for the EnrollmentStatusScope resource.

Inheritance

object > EnrollmentStatusScopeName

Implements

IResourceName, IEquatableEnrollmentStatusScopeName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AuditManager.V1

Assembly

Google.Cloud.AuditManager.V1.dll

Constructors

EnrollmentStatusScopeName(string, string)

public EnrollmentStatusScopeName(string folderId, string locationId)

Constructs a new instance of a EnrollmentStatusScopeName class from the component parts of pattern folders/{folder}/locations/{location}

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.

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

Type

public EnrollmentStatusScopeName.ResourceNameType Type { get; }

The EnrollmentStatusScopeName.ResourceNameType of the contained resource name.

Property Value
Type	Description
EnrollmentStatusScopeNameResourceNameType

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

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

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.

Returns
Type	Description
string	The string representation of this EnrollmentStatusScopeName with pattern folders/{folder}/locations/{location}.

FormatFolderLocation(string, string)

public static string FormatFolderLocation(string folderId, string locationId)

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

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.

Returns
Type	Description
string	The string representation of this EnrollmentStatusScopeName with pattern folders/{folder}/locations/{location}.

FormatOrganizationLocation(string, string)

public static string FormatOrganizationLocation(string organizationId, string locationId)

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

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.

Returns
Type	Description
string	The string representation of this EnrollmentStatusScopeName with pattern organizations/{organization}/locations/{location}.

FromFolderLocation(string, string)

public static EnrollmentStatusScopeName FromFolderLocation(string folderId, string locationId)

Creates a EnrollmentStatusScopeName with the pattern folders/{folder}/locations/{location} .

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.

Returns
Type	Description
EnrollmentStatusScopeName	A new instance of EnrollmentStatusScopeName constructed from the provided ids.

FromOrganizationLocation(string, string)

public static EnrollmentStatusScopeName FromOrganizationLocation(string organizationId, string locationId)

Creates a EnrollmentStatusScopeName with the pattern organizations/{organization}/locations/{location}.

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.

Returns
Type	Description
EnrollmentStatusScopeName	A new instance of EnrollmentStatusScopeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EnrollmentStatusScopeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EnrollmentStatusScopeName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
EnrollmentStatusScopeName	A new instance of EnrollmentStatusScopeName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static EnrollmentStatusScopeName Parse(string enrollmentStatusScopeName)

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

Parameter
Name	Description
enrollmentStatusScopeName	string The resource name in string form. Must not be null.

Returns
Type	Description
EnrollmentStatusScopeName	The parsed EnrollmentStatusScopeName if successful.

Remarks

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

• folders/{folder}/locations/{location}
• organizations/{organization}/locations/{location}

Parse(string, bool)

public static EnrollmentStatusScopeName Parse(string enrollmentStatusScopeName, bool allowUnparsed)

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

Parameters
Name	Description
enrollmentStatusScopeName	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
EnrollmentStatusScopeName	The parsed EnrollmentStatusScopeName if successful.

Remarks

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

• folders/{folder}/locations/{location}
• organizations/{organization}/locations/{location}

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

object.ToString()

TryParse(string, out EnrollmentStatusScopeName)

public static bool TryParse(string enrollmentStatusScopeName, out EnrollmentStatusScopeName result)

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

Parameters
Name	Description
enrollmentStatusScopeName	string The resource name in string form. Must not be null.
result	EnrollmentStatusScopeName When this method returns, the parsed EnrollmentStatusScopeName, 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:

• folders/{folder}/locations/{location}
• organizations/{organization}/locations/{location}

TryParse(string, bool, out EnrollmentStatusScopeName)

public static bool TryParse(string enrollmentStatusScopeName, bool allowUnparsed, out EnrollmentStatusScopeName result)

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

Parameters
Name	Description
enrollmentStatusScopeName	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	EnrollmentStatusScopeName When this method returns, the parsed EnrollmentStatusScopeName, 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:

• folders/{folder}/locations/{location}
• organizations/{organization}/locations/{location}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(EnrollmentStatusScopeName, EnrollmentStatusScopeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	EnrollmentStatusScopeName The first resource name to compare, or null.
b	EnrollmentStatusScopeName 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 !=(EnrollmentStatusScopeName, EnrollmentStatusScopeName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	EnrollmentStatusScopeName The first resource name to compare, or null.
b	EnrollmentStatusScopeName 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.