Migration Center v1 API - Class ErrorFrameName (1.0.0-beta01)

public sealed class ErrorFrameName : IResourceName, IEquatable<ErrorFrameName>

Reference documentation and code samples for the Migration Center v1 API class ErrorFrameName.

Resource name for the ErrorFrame resource.

Inheritance

object > ErrorFrameName

Namespace

Google.Cloud.MigrationCenter.V1

Assembly

Google.Cloud.MigrationCenter.V1.dll

Constructors

ErrorFrameName(string, string, string, string)

public ErrorFrameName(string projectId, string locationId, string sourceId, string errorFrameId)

Constructs a new instance of a ErrorFrameName class from the component parts of pattern projects/{project}/locations/{location}/sources/{source}/errorFrames/{error_frame}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

sourceIdstring

The Source ID. Must not be null or empty.

errorFrameIdstring

The ErrorFrame ID. Must not be null or empty.

Properties

ErrorFrameId

public string ErrorFrameId { get; }

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

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

SourceId

public string SourceId { get; }

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

Property Value
TypeDescription
string

Type

public ErrorFrameName.ResourceNameType Type { get; }

The ErrorFrameName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ErrorFrameNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string sourceId, string errorFrameId)

Formats the IDs into the string representation of this ErrorFrameName with pattern projects/{project}/locations/{location}/sources/{source}/errorFrames/{error_frame}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

sourceIdstring

The Source ID. Must not be null or empty.

errorFrameIdstring

The ErrorFrame ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ErrorFrameName with pattern projects/{project}/locations/{location}/sources/{source}/errorFrames/{error_frame}.

FormatProjectLocationSourceErrorFrame(string, string, string, string)

public static string FormatProjectLocationSourceErrorFrame(string projectId, string locationId, string sourceId, string errorFrameId)

Formats the IDs into the string representation of this ErrorFrameName with pattern projects/{project}/locations/{location}/sources/{source}/errorFrames/{error_frame}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

sourceIdstring

The Source ID. Must not be null or empty.

errorFrameIdstring

The ErrorFrame ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ErrorFrameName with pattern projects/{project}/locations/{location}/sources/{source}/errorFrames/{error_frame}.

FromProjectLocationSourceErrorFrame(string, string, string, string)

public static ErrorFrameName FromProjectLocationSourceErrorFrame(string projectId, string locationId, string sourceId, string errorFrameId)

Creates a ErrorFrameName with the pattern projects/{project}/locations/{location}/sources/{source}/errorFrames/{error_frame}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

sourceIdstring

The Source ID. Must not be null or empty.

errorFrameIdstring

The ErrorFrame ID. Must not be null or empty.

Returns
TypeDescription
ErrorFrameName

A new instance of ErrorFrameName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ErrorFrameName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ErrorFrameName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ErrorFrameName

A new instance of ErrorFrameName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static ErrorFrameName Parse(string errorFrameName)

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

Parameter
NameDescription
errorFrameNamestring

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

Returns
TypeDescription
ErrorFrameName

The parsed ErrorFrameName if successful.

Remarks

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

  • projects/{project}/locations/{location}/sources/{source}/errorFrames/{error_frame}

Parse(string, bool)

public static ErrorFrameName Parse(string errorFrameName, bool allowUnparsed)

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

Parameters
NameDescription
errorFrameNamestring

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

allowUnparsedbool

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
TypeDescription
ErrorFrameName

The parsed ErrorFrameName if successful.

Remarks

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

  • projects/{project}/locations/{location}/sources/{source}/errorFrames/{error_frame}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out ErrorFrameName)

public static bool TryParse(string errorFrameName, out ErrorFrameName result)

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

Parameters
NameDescription
errorFrameNamestring

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

resultErrorFrameName

When this method returns, the parsed ErrorFrameName, or null if parsing failed.

Returns
TypeDescription
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}/sources/{source}/errorFrames/{error_frame}

TryParse(string, bool, out ErrorFrameName)

public static bool TryParse(string errorFrameName, bool allowUnparsed, out ErrorFrameName result)

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

Parameters
NameDescription
errorFrameNamestring

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

allowUnparsedbool

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.

resultErrorFrameName

When this method returns, the parsed ErrorFrameName, or null if parsing failed.

Returns
TypeDescription
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}/sources/{source}/errorFrames/{error_frame}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ErrorFrameName, ErrorFrameName)

public static bool operator ==(ErrorFrameName a, ErrorFrameName b)
Parameters
NameDescription
aErrorFrameName
bErrorFrameName
Returns
TypeDescription
bool

operator !=(ErrorFrameName, ErrorFrameName)

public static bool operator !=(ErrorFrameName a, ErrorFrameName b)
Parameters
NameDescription
aErrorFrameName
bErrorFrameName
Returns
TypeDescription
bool