NetApp v1 API - Class ActiveDirectoryName (1.3.0)

public sealed class ActiveDirectoryName : IResourceName, IEquatable<ActiveDirectoryName>

Reference documentation and code samples for the NetApp v1 API class ActiveDirectoryName.

Resource name for the ActiveDirectory resource.

Inheritance

object > ActiveDirectoryName

Namespace

Google.Cloud.NetApp.V1

Assembly

Google.Cloud.NetApp.V1.dll

Constructors

ActiveDirectoryName(string, string, string)

public ActiveDirectoryName(string projectId, string locationId, string activeDirectoryId)

Constructs a new instance of a ActiveDirectoryName class from the component parts of pattern projects/{project}/locations/{location}/activeDirectories/{active_directory}

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.

activeDirectoryId string

The ActiveDirectory ID. Must not be null or empty.

Properties

ActiveDirectoryId

public string ActiveDirectoryId { get; }

The ActiveDirectory ID. Will not be null, unless this instance contains an unparsed resource name.

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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public ActiveDirectoryName.ResourceNameType Type { get; }

The ActiveDirectoryName.ResourceNameType of the contained resource name.

Property Value
Type Description
ActiveDirectoryNameResourceNameType

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

Formats the IDs into the string representation of this ActiveDirectoryName with pattern projects/{project}/locations/{location}/activeDirectories/{active_directory}.

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.

activeDirectoryId string

The ActiveDirectory ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ActiveDirectoryName with pattern projects/{project}/locations/{location}/activeDirectories/{active_directory}.

FormatProjectLocationActiveDirectory(string, string, string)

public static string FormatProjectLocationActiveDirectory(string projectId, string locationId, string activeDirectoryId)

Formats the IDs into the string representation of this ActiveDirectoryName with pattern projects/{project}/locations/{location}/activeDirectories/{active_directory}.

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.

activeDirectoryId string

The ActiveDirectory ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ActiveDirectoryName with pattern projects/{project}/locations/{location}/activeDirectories/{active_directory}.

FromProjectLocationActiveDirectory(string, string, string)

public static ActiveDirectoryName FromProjectLocationActiveDirectory(string projectId, string locationId, string activeDirectoryId)

Creates a ActiveDirectoryName with the pattern projects/{project}/locations/{location}/activeDirectories/{active_directory}.

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.

activeDirectoryId string

The ActiveDirectory ID. Must not be null or empty.

Returns
Type Description
ActiveDirectoryName

A new instance of ActiveDirectoryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ActiveDirectoryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ActiveDirectoryName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ActiveDirectoryName

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

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

Parameter
Name Description
activeDirectoryName string

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

Returns
Type Description
ActiveDirectoryName

The parsed ActiveDirectoryName if successful.

Remarks

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

  • projects/{project}/locations/{location}/activeDirectories/{active_directory}

Parse(string, bool)

public static ActiveDirectoryName Parse(string activeDirectoryName, bool allowUnparsed)

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

Parameters
Name Description
activeDirectoryName 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
ActiveDirectoryName

The parsed ActiveDirectoryName if successful.

Remarks

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

  • projects/{project}/locations/{location}/activeDirectories/{active_directory}
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 ActiveDirectoryName)

public static bool TryParse(string activeDirectoryName, out ActiveDirectoryName result)

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

Parameters
Name Description
activeDirectoryName string

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

result ActiveDirectoryName

When this method returns, the parsed ActiveDirectoryName, 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}/activeDirectories/{active_directory}

TryParse(string, bool, out ActiveDirectoryName)

public static bool TryParse(string activeDirectoryName, bool allowUnparsed, out ActiveDirectoryName result)

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

Parameters
Name Description
activeDirectoryName 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 ActiveDirectoryName

When this method returns, the parsed ActiveDirectoryName, 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}/activeDirectories/{active_directory}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ActiveDirectoryName, ActiveDirectoryName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ActiveDirectoryName

The first resource name to compare, or null.

b ActiveDirectoryName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ActiveDirectoryName

The first resource name to compare, or null.

b ActiveDirectoryName

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.