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

public sealed class EnrollmentName : IResourceName, IEquatable<EnrollmentName>

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

Resource name for the Enrollment resource.

Inheritance

object > EnrollmentName

Namespace

Google.Cloud.AuditManager.V1

Assembly

Google.Cloud.AuditManager.V1.dll

Constructors

EnrollmentName(string, string, string)

public EnrollmentName(string projectId, string locationId, string enrollmentId)

Constructs a new instance of a EnrollmentName class from the component parts of pattern projects/{project}/locations/{location}/enrollments/{enrollment}

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

The Enrollment ID. Must not be null or empty.

Properties

EnrollmentId

public string EnrollmentId { get; }

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

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

Type

public EnrollmentName.ResourceNameType Type { get; }

The EnrollmentName.ResourceNameType of the contained resource name.

Property Value
Type Description
EnrollmentNameResourceNameType

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

Formats the IDs into the string representation of this EnrollmentName with pattern projects/{project}/locations/{location}/enrollments/{enrollment}.

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

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

The string representation of this EnrollmentName with pattern projects/{project}/locations/{location}/enrollments/{enrollment}.

FormatFolderLocationEnrollment(string, string, string)

public static string FormatFolderLocationEnrollment(string folderId, string locationId, string enrollmentId)

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

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

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

The string representation of this EnrollmentName with pattern folders/{folder}/locations/{location}/enrollments/{enrollment}.

FormatOrganizationLocationEnrollment(string, string, string)

public static string FormatOrganizationLocationEnrollment(string organizationId, string locationId, string enrollmentId)

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

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

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

The string representation of this EnrollmentName with pattern organizations/{organization}/locations/{location}/enrollments/{enrollment}.

FormatProjectLocationEnrollment(string, string, string)

public static string FormatProjectLocationEnrollment(string projectId, string locationId, string enrollmentId)

Formats the IDs into the string representation of this EnrollmentName with pattern projects/{project}/locations/{location}/enrollments/{enrollment}.

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

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

The string representation of this EnrollmentName with pattern projects/{project}/locations/{location}/enrollments/{enrollment}.

FromFolderLocationEnrollment(string, string, string)

public static EnrollmentName FromFolderLocationEnrollment(string folderId, string locationId, string enrollmentId)

Creates a EnrollmentName with the pattern folders/{folder}/locations/{location}/enrollments/{enrollment}.

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

The Enrollment ID. Must not be null or empty.
Returns
Type Description
EnrollmentName

A new instance of EnrollmentName constructed from the provided ids.

FromOrganizationLocationEnrollment(string, string, string)

public static EnrollmentName FromOrganizationLocationEnrollment(string organizationId, string locationId, string enrollmentId)

Creates a EnrollmentName with the pattern organizations/{organization}/locations/{location}/enrollments/{enrollment}.

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

The Enrollment ID. Must not be null or empty.
Returns
Type Description
EnrollmentName

A new instance of EnrollmentName constructed from the provided ids.

FromProjectLocationEnrollment(string, string, string)

public static EnrollmentName FromProjectLocationEnrollment(string projectId, string locationId, string enrollmentId)

Creates a EnrollmentName with the pattern projects/{project}/locations/{location}/enrollments/{enrollment}.

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

The Enrollment ID. Must not be null or empty.
Returns
Type Description
EnrollmentName

A new instance of EnrollmentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EnrollmentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EnrollmentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
enrollmentName string

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

The parsed EnrollmentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/enrollments/{enrollment}
  • folders/{folder}/locations/{location}/enrollments/{enrollment}
  • organizations/{organization}/locations/{location}/enrollments/{enrollment}

Parse(string, bool)

public static EnrollmentName Parse(string enrollmentName, bool allowUnparsed)

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

Parameters
Name Description
enrollmentName 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
EnrollmentName

The parsed EnrollmentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/enrollments/{enrollment}
  • folders/{folder}/locations/{location}/enrollments/{enrollment}
  • organizations/{organization}/locations/{location}/enrollments/{enrollment}
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 EnrollmentName)

public static bool TryParse(string enrollmentName, out EnrollmentName result)

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

Parameters
Name Description
enrollmentName string

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

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

TryParse(string, bool, out EnrollmentName)

public static bool TryParse(string enrollmentName, bool allowUnparsed, out EnrollmentName result)

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

Parameters
Name Description
enrollmentName 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 EnrollmentName

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

Operators

operator ==(EnrollmentName, EnrollmentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EnrollmentName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EnrollmentName

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

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.