Class FolderName

Resource name for the 'folder' resource which is widespread across Google Cloud Platform. While most resource names are generated on a per-API basis, many APIs use a folder resource, and it's useful to be able to pass values from one API to another.

Inheritance

System.Object

FolderName

Implements

IResourceName

System.IEquatable<FolderName>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Api.Gax.ResourceNames

Assembly: Google.Api.Gax.dll

Syntax

public sealed class FolderName : IResourceName, IEquatable<FolderName>

Constructors

FolderName(String)

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

Declaration

public FolderName(string folderId)

Parameters

Type	Name	Description
System.String	folderId	The Folder ID. Must not be null or empty.

Properties

FolderId

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

Declaration

public string FolderId { get; }

Property Value

Type	Description
System.String

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
System.Boolean

Implements

IResourceName.IsKnownPattern

Type

The FolderName.ResourceNameType of the contained resource name.

Declaration

public FolderName.ResourceNameType Type { get; }

Property Value

Type	Description
FolderName.ResourceNameType

UnparsedResource

The contained UnparsedResourceName. Only non-nullif this instance contains an unparsed resource name.

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Equals(FolderName)

Declaration

public bool Equals(FolderName other)

Parameters

Type	Name	Description
FolderName	other

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

Format(String)

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

Declaration

public static string Format(string folderId)

Parameters

Type	Name	Description
System.String	folderId	The Folder ID. Must not be null or empty.

Returns

Type	Description
System.String	The string representation of this FolderName with pattern folders/{folder}.

FormatFolder(String)

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

Declaration

public static string FormatFolder(string folderId)

Parameters

Type	Name	Description
System.String	folderId	The Folder ID. Must not be null or empty.

Returns

Type	Description
System.String	The string representation of this FolderName with pattern folders/{folder}.

FromFolder(String)

Creates a FolderName with the pattern folders/{folder}.

Declaration

public static FolderName FromFolder(string folderId)

Parameters

Type	Name	Description
System.String	folderId	The Folder ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a FolderName containing an unparsed resource name.

Declaration

public static FolderName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
FolderName	A new instance of FolderName containing the provided unparsedResourceName.

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

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

Declaration

public static FolderName Parse(string folderName)

Parameters

Type	Name	Description
System.String	folderName	The resource name in string form. Must not be null.

Returns

Type	Description
FolderName	The parsed FolderName if successful.

Remarks

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

• folders/{folder}

Parse(String, Boolean)

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

Declaration

public static FolderName Parse(string folderName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	folderName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.

Returns

Type	Description
FolderName	The parsed FolderName if successful.

Remarks

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

• folders/{folder}

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of the resource name.

Overrides

System.Object.ToString()

Implements

IResourceName.ToString()

TryParse(String, out FolderName)

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

Declaration

public static bool TryParse(string folderName, out FolderName result)

Parameters

Type	Name	Description
System.String	folderName	The resource name in string form. Must not be null.
FolderName	result	When this method returns, the parsed FolderName, or null if parsing failed.

Returns

Type	Description
System.Boolean	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}

TryParse(String, Boolean, out FolderName)

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

Declaration

public static bool TryParse(string folderName, bool allowUnparsed, out FolderName result)

Parameters

Type	Name	Description
System.String	folderName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
FolderName	result	When this method returns, the parsed FolderName, or null if parsing failed.

Returns

Type	Description
System.Boolean	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}

Or may be in any format if allowUnparsed is true.

Operators

Equality(FolderName, FolderName)

Declaration

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

Parameters

Type	Name	Description
FolderName	a
FolderName	b

Returns

Type	Description
System.Boolean

Inequality(FolderName, FolderName)

Declaration

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

Parameters

Type	Name	Description
FolderName	a
FolderName	b

Returns

Type	Description
System.Boolean