Dataform v1beta1 API - Class TeamFolderName (1.0.0-beta11) 

public sealed class TeamFolderName : IResourceName, IEquatable<TeamFolderName>

Reference documentation and code samples for the Dataform v1beta1 API class TeamFolderName.

Resource name for the TeamFolder resource.

Inheritance

object > TeamFolderName

Namespace

Google.Cloud.Dataform.V1Beta1

Assembly

Google.Cloud.Dataform.V1Beta1.dll

Constructors

TeamFolderName(string, string, string)

public TeamFolderName(string projectId, string locationId, string teamFolderId)

Constructs a new instance of a TeamFolderName class from the component parts of pattern projects/{project}/locations/{location}/teamFolders/{team_folder}

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

The TeamFolder ID. Must not be null or empty.

Properties

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

TeamFolderId

public string TeamFolderId { get; }

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

Property Value
Type Description
string

Type

public TeamFolderName.ResourceNameType Type { get; }

The TeamFolderName.ResourceNameType of the contained resource name.

Property Value
Type Description
TeamFolderNameResourceNameType

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

Formats the IDs into the string representation of this TeamFolderName with pattern projects/{project}/locations/{location}/teamFolders/{team_folder}.

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

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

The string representation of this TeamFolderName with pattern projects/{project}/locations/{location}/teamFolders/{team_folder}.

FormatProjectLocationTeamFolder(string, string, string)

public static string FormatProjectLocationTeamFolder(string projectId, string locationId, string teamFolderId)

Formats the IDs into the string representation of this TeamFolderName with pattern projects/{project}/locations/{location}/teamFolders/{team_folder}.

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

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

The string representation of this TeamFolderName with pattern projects/{project}/locations/{location}/teamFolders/{team_folder}.

FromProjectLocationTeamFolder(string, string, string)

public static TeamFolderName FromProjectLocationTeamFolder(string projectId, string locationId, string teamFolderId)

Creates a TeamFolderName with the pattern projects/{project}/locations/{location}/teamFolders/{team_folder}.

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

The TeamFolder ID. Must not be null or empty.
Returns
Type Description
TeamFolderName

A new instance of TeamFolderName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TeamFolderName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TeamFolderName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
teamFolderName string

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

The parsed TeamFolderName if successful.
Remarks

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

  • projects/{project}/locations/{location}/teamFolders/{team_folder}

Parse(string, bool)

public static TeamFolderName Parse(string teamFolderName, bool allowUnparsed)

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

Parameters
Name Description
teamFolderName 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
TeamFolderName

The parsed TeamFolderName if successful.
Remarks

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

  • projects/{project}/locations/{location}/teamFolders/{team_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 TeamFolderName)

public static bool TryParse(string teamFolderName, out TeamFolderName result)

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

Parameters
Name Description
teamFolderName string

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

When this method returns, the parsed TeamFolderName, 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}/teamFolders/{team_folder}

TryParse(string, bool, out TeamFolderName)

public static bool TryParse(string teamFolderName, bool allowUnparsed, out TeamFolderName result)

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

Parameters
Name Description
teamFolderName 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 TeamFolderName

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

Operators

operator ==(TeamFolderName, TeamFolderName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TeamFolderName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a TeamFolderName

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

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.