Video Stitcher v1 API - Class CdnKeyName (2.0.0) 

public sealed class CdnKeyName : IResourceName, IEquatable<CdnKeyName>

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

Resource name for the CdnKey resource.

Inheritance

object > CdnKeyName

Namespace

GoogleCloudGoogle.Cloud.VideoGoogle.Cloud.Video.StitcherV1

Assembly

Google.Cloud.Video.Stitcher.V1.dll

Constructors

CdnKeyName(string, string, string)

public CdnKeyName(string projectId, string locationId, string cdnKeyId)

Constructs a new instance of a CdnKeyName class from the component parts of pattern projects/{project}/locations/{location}/cdnKeys/{cdn_key}

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

The CdnKey ID. Must not be null or empty.

Properties

CdnKeyId

public string CdnKeyId { get; }

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

Property Value
Type Description
string

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

Type

public CdnKeyName.ResourceNameType Type { get; }

The CdnKeyName.ResourceNameType of the contained resource name.

Property Value
Type Description
CdnKeyNameResourceNameType

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

Formats the IDs into the string representation of this CdnKeyName with pattern projects/{project}/locations/{location}/cdnKeys/{cdn_key}.

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

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

The string representation of this CdnKeyName with pattern projects/{project}/locations/{location}/cdnKeys/{cdn_key}.

FormatProjectLocationCdnKey(string, string, string)

public static string FormatProjectLocationCdnKey(string projectId, string locationId, string cdnKeyId)

Formats the IDs into the string representation of this CdnKeyName with pattern projects/{project}/locations/{location}/cdnKeys/{cdn_key}.

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

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

The string representation of this CdnKeyName with pattern projects/{project}/locations/{location}/cdnKeys/{cdn_key}.

FromProjectLocationCdnKey(string, string, string)

public static CdnKeyName FromProjectLocationCdnKey(string projectId, string locationId, string cdnKeyId)

Creates a CdnKeyName with the pattern projects/{project}/locations/{location}/cdnKeys/{cdn_key}.

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

The CdnKey ID. Must not be null or empty.
Returns
Type Description
CdnKeyName

A new instance of CdnKeyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CdnKeyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CdnKeyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
cdnKeyName string

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

The parsed CdnKeyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/cdnKeys/{cdn_key}

Parse(string, bool)

public static CdnKeyName Parse(string cdnKeyName, bool allowUnparsed)

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

Parameters
Name Description
cdnKeyName 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
CdnKeyName

The parsed CdnKeyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/cdnKeys/{cdn_key}
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 CdnKeyName)

public static bool TryParse(string cdnKeyName, out CdnKeyName result)

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

Parameters
Name Description
cdnKeyName string

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

When this method returns, the parsed CdnKeyName, 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}/cdnKeys/{cdn_key}

TryParse(string, bool, out CdnKeyName)

public static bool TryParse(string cdnKeyName, bool allowUnparsed, out CdnKeyName result)

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

Parameters
Name Description
cdnKeyName 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 CdnKeyName

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

Operators

operator ==(CdnKeyName, CdnKeyName)

public static bool operator ==(CdnKeyName a, CdnKeyName b)
Parameters
Name Description
a CdnKeyName
b CdnKeyName
Returns
Type Description
bool

operator !=(CdnKeyName, CdnKeyName)

public static bool operator !=(CdnKeyName a, CdnKeyName b)
Parameters
Name Description
a CdnKeyName
b CdnKeyName
Returns
Type Description
bool