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

public sealed class ResourceEnrollmentStatusName : IResourceName, IEquatable<ResourceEnrollmentStatusName>

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

Resource name for the ResourceEnrollmentStatus resource.

Inheritance

object > ResourceEnrollmentStatusName

Namespace

Google.Cloud.AuditManager.V1

Assembly

Google.Cloud.AuditManager.V1.dll

Constructors

ResourceEnrollmentStatusName(string, string, string)

public ResourceEnrollmentStatusName(string folderId, string locationId, string resourceEnrollmentStatusId)

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

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.

resourceEnrollmentStatusId string

The ResourceEnrollmentStatus 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

ResourceEnrollmentStatusId

public string ResourceEnrollmentStatusId { get; }

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

Property Value
Type Description
string

Type

public ResourceEnrollmentStatusName.ResourceNameType Type { get; }

The ResourceEnrollmentStatusName.ResourceNameType of the contained resource name.

Property Value
Type Description
ResourceEnrollmentStatusNameResourceNameType

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

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

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.

resourceEnrollmentStatusId string

The ResourceEnrollmentStatus ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ResourceEnrollmentStatusName with pattern folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}.

FormatFolderLocationResourceEnrollmentStatus(string, string, string)

public static string FormatFolderLocationResourceEnrollmentStatus(string folderId, string locationId, string resourceEnrollmentStatusId)

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

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.

resourceEnrollmentStatusId string

The ResourceEnrollmentStatus ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ResourceEnrollmentStatusName with pattern folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}.

FormatOrganizationLocationResourceEnrollmentStatus(string, string, string)

public static string FormatOrganizationLocationResourceEnrollmentStatus(string organizationId, string locationId, string resourceEnrollmentStatusId)

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

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.

resourceEnrollmentStatusId string

The ResourceEnrollmentStatus ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ResourceEnrollmentStatusName with pattern organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status} .

FormatProjectLocationResourceEnrollmentStatus(string, string, string)

public static string FormatProjectLocationResourceEnrollmentStatus(string projectId, string locationId, string resourceEnrollmentStatusId)

Formats the IDs into the string representation of this ResourceEnrollmentStatusName with pattern projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status} .

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.

resourceEnrollmentStatusId string

The ResourceEnrollmentStatus ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ResourceEnrollmentStatusName with pattern projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}.

FromFolderLocationResourceEnrollmentStatus(string, string, string)

public static ResourceEnrollmentStatusName FromFolderLocationResourceEnrollmentStatus(string folderId, string locationId, string resourceEnrollmentStatusId)

Creates a ResourceEnrollmentStatusName with the pattern folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}.

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.

resourceEnrollmentStatusId string

The ResourceEnrollmentStatus ID. Must not be null or empty.

Returns
Type Description
ResourceEnrollmentStatusName

A new instance of ResourceEnrollmentStatusName constructed from the provided ids.

FromOrganizationLocationResourceEnrollmentStatus(string, string, string)

public static ResourceEnrollmentStatusName FromOrganizationLocationResourceEnrollmentStatus(string organizationId, string locationId, string resourceEnrollmentStatusId)

Creates a ResourceEnrollmentStatusName with the pattern organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status} .

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.

resourceEnrollmentStatusId string

The ResourceEnrollmentStatus ID. Must not be null or empty.

Returns
Type Description
ResourceEnrollmentStatusName

A new instance of ResourceEnrollmentStatusName constructed from the provided ids.

FromProjectLocationResourceEnrollmentStatus(string, string, string)

public static ResourceEnrollmentStatusName FromProjectLocationResourceEnrollmentStatus(string projectId, string locationId, string resourceEnrollmentStatusId)

Creates a ResourceEnrollmentStatusName with the pattern projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}.

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.

resourceEnrollmentStatusId string

The ResourceEnrollmentStatus ID. Must not be null or empty.

Returns
Type Description
ResourceEnrollmentStatusName

A new instance of ResourceEnrollmentStatusName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ResourceEnrollmentStatusName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ResourceEnrollmentStatusName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ResourceEnrollmentStatusName

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

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

Parameter
Name Description
resourceEnrollmentStatusName string

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

Returns
Type Description
ResourceEnrollmentStatusName

The parsed ResourceEnrollmentStatusName if successful.

Remarks

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

  • folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
  • projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
  • organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}

Parse(string, bool)

public static ResourceEnrollmentStatusName Parse(string resourceEnrollmentStatusName, bool allowUnparsed)

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

Parameters
Name Description
resourceEnrollmentStatusName 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
ResourceEnrollmentStatusName

The parsed ResourceEnrollmentStatusName if successful.

Remarks

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

  • folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
  • projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
  • organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
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 ResourceEnrollmentStatusName)

public static bool TryParse(string resourceEnrollmentStatusName, out ResourceEnrollmentStatusName result)

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

Parameters
Name Description
resourceEnrollmentStatusName string

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

result ResourceEnrollmentStatusName

When this method returns, the parsed ResourceEnrollmentStatusName, 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}/resourceEnrollmentStatuses/{resource_enrollment_status}
  • projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
  • organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}

TryParse(string, bool, out ResourceEnrollmentStatusName)

public static bool TryParse(string resourceEnrollmentStatusName, bool allowUnparsed, out ResourceEnrollmentStatusName result)

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

Parameters
Name Description
resourceEnrollmentStatusName 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 ResourceEnrollmentStatusName

When this method returns, the parsed ResourceEnrollmentStatusName, 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}/resourceEnrollmentStatuses/{resource_enrollment_status}
  • projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
  • organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ResourceEnrollmentStatusName, ResourceEnrollmentStatusName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ResourceEnrollmentStatusName

The first resource name to compare, or null.

b ResourceEnrollmentStatusName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ResourceEnrollmentStatusName

The first resource name to compare, or null.

b ResourceEnrollmentStatusName

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.