Class FolderName (4.0.0) 

public sealed class FolderName : IResourceName, IEquatable<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

Object > FolderName

Namespace

Google.Api.Gax.ResourceNames

Assembly

Google.Api.Gax.dll

Constructors

FolderName(String)

public FolderName(string folderId)

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

Parameter
Name Description
folderId String

The Folder ID. Must not be null or empty.

Properties

FolderId

public string FolderId { get; }

The Folder 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
Boolean

Type

public FolderName.ResourceNameType Type { get; }

The FolderName.ResourceNameType of the contained resource name.

Property Value
Type Description
FolderName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

Methods

Equals(FolderName)

public bool Equals(FolderName other)
Parameter
Name Description
other FolderName
Returns
Type Description
Boolean

Equals(Object)

public override bool Equals(object obj)
Parameter
Name Description
obj Object
Returns
Type Description
Boolean
Overrides

Format(String)

public static string Format(string folderId)

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

Parameter
Name Description
folderId String

The Folder ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this FolderName with pattern folders/{folder}.

FormatFolder(String)

public static string FormatFolder(string folderId)

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

Parameter
Name Description
folderId String

The Folder ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this FolderName with pattern folders/{folder}.

FromFolder(String)

public static FolderName FromFolder(string folderId)

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

Parameter
Name Description
folderId String

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)

public static FolderName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FolderName containing an unparsed resource name.

Parameter
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()

public override int GetHashCode()
Returns
Type Description
Int32
Overrides

Parse(String)

public static FolderName Parse(string folderName)

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

Parameter
Name Description
folderName String

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)

public static FolderName Parse(string folderName, bool allowUnparsed)

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

Parameters
Name Description
folderName String

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

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

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

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

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

Parameters
Name Description
folderName String

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

When this method returns, the parsed FolderName, or null if parsing failed.
Returns
Type Description
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)

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

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

Parameters
Name Description
folderName String

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

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 FolderName

When this method returns, the parsed FolderName, or null if parsing failed.
Returns
Type Description
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)

public static bool operator ==(FolderName a, FolderName b)
Parameters
Name Description
a FolderName
b FolderName
Returns
Type Description
Boolean

Inequality(FolderName, FolderName)

public static bool operator !=(FolderName a, FolderName b)
Parameters
Name Description
a FolderName
b FolderName
Returns
Type Description
Boolean