Video Stitcher v1 API - Class SlateName (3.0.0-beta01)

public sealed class SlateName : IResourceName, IEquatable<SlateName>

Reference documentation and code samples for the Video Stitcher v1 API class SlateName.

Resource name for the Slate resource.

Inheritance

object > SlateName

Namespace

Google.Cloud.Video.Stitcher.V1

Assembly

Google.Cloud.Video.Stitcher.V1.dll

Constructors

SlateName(string, string, string)

public SlateName(string projectId, string locationId, string slateId)

Constructs a new instance of a SlateName class from the component parts of pattern projects/{project}/locations/{location}/slates/{slate}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

slateIdstring

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

SlateId

public string SlateId { get; }

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

Property Value
TypeDescription
string

Type

public SlateName.ResourceNameType Type { get; }

The SlateName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
SlateNameResourceNameType

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)

public static string Format(string projectId, string locationId, string slateId)

Formats the IDs into the string representation of this SlateName with pattern projects/{project}/locations/{location}/slates/{slate}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

slateIdstring

The Slate ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this SlateName with pattern projects/{project}/locations/{location}/slates/{slate}.

FormatProjectLocationSlate(string, string, string)

public static string FormatProjectLocationSlate(string projectId, string locationId, string slateId)

Formats the IDs into the string representation of this SlateName with pattern projects/{project}/locations/{location}/slates/{slate}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

slateIdstring

The Slate ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this SlateName with pattern projects/{project}/locations/{location}/slates/{slate}.

FromProjectLocationSlate(string, string, string)

public static SlateName FromProjectLocationSlate(string projectId, string locationId, string slateId)

Creates a SlateName with the pattern projects/{project}/locations/{location}/slates/{slate} .

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

slateIdstring

The Slate ID. Must not be null or empty.

Returns
TypeDescription
SlateName

A new instance of SlateName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SlateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SlateName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
SlateName

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

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

Parameter
NameDescription
slateNamestring

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

Returns
TypeDescription
SlateName

The parsed SlateName if successful.

Remarks

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

  • projects/{project}/locations/{location}/slates/{slate}

Parse(string, bool)

public static SlateName Parse(string slateName, bool allowUnparsed)

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

Parameters
NameDescription
slateNamestring

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
SlateName

The parsed SlateName if successful.

Remarks

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

  • projects/{project}/locations/{location}/slates/{slate}
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 SlateName)

public static bool TryParse(string slateName, out SlateName result)

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

Parameters
NameDescription
slateNamestring

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

resultSlateName

When this method returns, the parsed SlateName, 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}/slates/{slate}

TryParse(string, bool, out SlateName)

public static bool TryParse(string slateName, bool allowUnparsed, out SlateName result)

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

Parameters
NameDescription
slateNamestring

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.

resultSlateName

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

Operators

operator ==(SlateName, SlateName)

public static bool operator ==(SlateName a, SlateName b)
Parameters
NameDescription
aSlateName
bSlateName
Returns
TypeDescription
bool

operator !=(SlateName, SlateName)

public static bool operator !=(SlateName a, SlateName b)
Parameters
NameDescription
aSlateName
bSlateName
Returns
TypeDescription
bool