VMware Engine v1 API - Class LoggingServerName (1.6.0) 

public sealed class LoggingServerName : IResourceName, IEquatable<LoggingServerName>

Reference documentation and code samples for the VMware Engine v1 API class LoggingServerName.

Resource name for the LoggingServer resource.

Inheritance

object > LoggingServerName

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Constructors

LoggingServerName(string, string, string, string)

public LoggingServerName(string projectId, string locationId, string privateCloudId, string loggingServerId)

Constructs a new instance of a LoggingServerName class from the component parts of pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/loggingServers/{logging_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.
privateCloudId string

The PrivateCloud ID. Must not be null or empty.
loggingServerId string

The LoggingServer 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

LoggingServerId

public string LoggingServerId { get; }

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

Property Value
Type Description
string

PrivateCloudId

public string PrivateCloudId { get; }

The PrivateCloud 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 LoggingServerName.ResourceNameType Type { get; }

The LoggingServerName.ResourceNameType of the contained resource name.

Property Value
Type Description
LoggingServerNameResourceNameType

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, string)

public static string Format(string projectId, string locationId, string privateCloudId, string loggingServerId)

Formats the IDs into the string representation of this LoggingServerName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/loggingServers/{logging_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.
privateCloudId string

The PrivateCloud ID. Must not be null or empty.
loggingServerId string

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

The string representation of this LoggingServerName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/loggingServers/{logging_server} .

FormatProjectLocationPrivateCloudLoggingServer(string, string, string, string)

public static string FormatProjectLocationPrivateCloudLoggingServer(string projectId, string locationId, string privateCloudId, string loggingServerId)

Formats the IDs into the string representation of this LoggingServerName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/loggingServers/{logging_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.
privateCloudId string

The PrivateCloud ID. Must not be null or empty.
loggingServerId string

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

The string representation of this LoggingServerName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/loggingServers/{logging_server} .

FromProjectLocationPrivateCloudLoggingServer(string, string, string, string)

public static LoggingServerName FromProjectLocationPrivateCloudLoggingServer(string projectId, string locationId, string privateCloudId, string loggingServerId)

Creates a LoggingServerName with the pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/loggingServers/{logging_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.
privateCloudId string

The PrivateCloud ID. Must not be null or empty.
loggingServerId string

The LoggingServer ID. Must not be null or empty.
Returns
Type Description
LoggingServerName

A new instance of LoggingServerName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LoggingServerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LoggingServerName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
loggingServerName string

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

The parsed LoggingServerName if successful.
Remarks

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

  • projects/{project}/locations/{location}/privateClouds/{private_cloud}/loggingServers/{logging_server}

Parse(string, bool)

public static LoggingServerName Parse(string loggingServerName, bool allowUnparsed)

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

Parameters
Name Description
loggingServerName 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
LoggingServerName

The parsed LoggingServerName if successful.
Remarks

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

  • projects/{project}/locations/{location}/privateClouds/{private_cloud}/loggingServers/{logging_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

TryParse(string, out LoggingServerName)

public static bool TryParse(string loggingServerName, out LoggingServerName result)

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

Parameters
Name Description
loggingServerName string

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

When this method returns, the parsed LoggingServerName, 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}/privateClouds/{private_cloud}/loggingServers/{logging_server}

TryParse(string, bool, out LoggingServerName)

public static bool TryParse(string loggingServerName, bool allowUnparsed, out LoggingServerName result)

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

Parameters
Name Description
loggingServerName 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 LoggingServerName

When this method returns, the parsed LoggingServerName, 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}/privateClouds/{private_cloud}/loggingServers/{logging_server}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(LoggingServerName, LoggingServerName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a LoggingServerName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a LoggingServerName

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

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.