Cloud FTP v1 API - Class ServerName (1.0.0-beta01)

public sealed class ServerName : IResourceName, IEquatable<ServerName>

Reference documentation and code samples for the Cloud FTP v1 API class ServerName.

Resource name for the Server resource.

Inheritance

object > ServerName

Implements

IResourceName, IEquatableServerName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Ftp.V1

Assembly

Google.Cloud.Ftp.V1.dll

Constructors

ServerName(string, string, string)

public ServerName(string projectId, string locationId, string serverId)

Constructs a new instance of a ServerName class from the component parts of pattern projects/{project}/locations/{location}/servers/{server}

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.
serverId	string The Server 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

ServerId

public string ServerId { get; }

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

Property Value
Type	Description
string

Type

public ServerName.ResourceNameType Type { get; }

The ServerName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ServerNameResourceNameType

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

Formats the IDs into the string representation of this ServerName with pattern projects/{project}/locations/{location}/servers/{server}.

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.
serverId	string The Server ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ServerName with pattern projects/{project}/locations/{location}/servers/{server}.

FormatProjectLocationServer(string, string, string)

public static string FormatProjectLocationServer(string projectId, string locationId, string serverId)

Formats the IDs into the string representation of this ServerName with pattern projects/{project}/locations/{location}/servers/{server}.

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.
serverId	string The Server ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ServerName with pattern projects/{project}/locations/{location}/servers/{server}.

FromProjectLocationServer(string, string, string)

public static ServerName FromProjectLocationServer(string projectId, string locationId, string serverId)

Creates a ServerName with the pattern projects/{project}/locations/{location}/servers/{server}.

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.
serverId	string The Server ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static ServerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ServerName containing an unparsed resource name.

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

Returns
Type	Description
ServerName	A new instance of ServerName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static ServerName Parse(string serverName)

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

Parameter
Name	Description
serverName	string The resource name in string form. Must not be null.

Returns
Type	Description
ServerName	The parsed ServerName if successful.

Remarks

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

• projects/{project}/locations/{location}/servers/{server}

Parse(string, bool)

public static ServerName Parse(string serverName, bool allowUnparsed)

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

Parameters
Name	Description
serverName	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
ServerName	The parsed ServerName if successful.

Remarks

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

• projects/{project}/locations/{location}/servers/{server}

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

object.ToString()

TryParse(string, out ServerName)

public static bool TryParse(string serverName, out ServerName result)

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

Parameters
Name	Description
serverName	string The resource name in string form. Must not be null.
result	ServerName When this method returns, the parsed ServerName, 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}/servers/{server}

TryParse(string, bool, out ServerName)

public static bool TryParse(string serverName, bool allowUnparsed, out ServerName result)

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

Parameters
Name	Description
serverName	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	ServerName When this method returns, the parsed ServerName, 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}/servers/{server}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ServerName, ServerName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	ServerName The first resource name to compare, or null.
b	ServerName 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 !=(ServerName, ServerName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	ServerName The first resource name to compare, or null.
b	ServerName 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.