Class AdBreakName

Resource name for the AdBreak resource.

Inheritance

object

AdBreakName

Implements

IResourceName

IEquatable<AdBreakName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class AdBreakName : IResourceName, IEquatable<AdBreakName>

Constructors

AdBreakName(string, string, string)

Constructs a new instance of a AdBreakName class from the component parts of pattern networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}

Declaration

public AdBreakName(string networkCodeId, string assetKeyId, string adBreakId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	assetKeyId	The AssetKey ID. Must not be null or empty.
string	adBreakId	The AdBreak ID. Must not be null or empty.

Properties

AdBreakId

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

Declaration

public string AdBreakId { get; }

Property Value

Type	Description
string

AssetKeyId

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

Declaration

public string AssetKeyId { get; }

Property Value

Type	Description
string

IsKnownPattern

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

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
bool

Implements

IResourceName.IsKnownPattern

NetworkCodeId

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

Declaration

public string NetworkCodeId { get; }

Property Value

Type	Description
string

Type

The AdBreakName.ResourceNameType of the contained resource name.

Declaration

public AdBreakName.ResourceNameType Type { get; }

Property Value

Type	Description
AdBreakName.ResourceNameType

UnparsedResource

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

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(string, string, string)

Formats the IDs into the string representation of this AdBreakName with pattern networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}.

Declaration

public static string Format(string networkCodeId, string assetKeyId, string adBreakId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	assetKeyId	The AssetKey ID. Must not be null or empty.
string	adBreakId	The AdBreak ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this AdBreakName with pattern networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}.

FormatNetworkCodeAssetKeyAdBreak(string, string, string)

Formats the IDs into the string representation of this AdBreakName with pattern networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}.

Declaration

public static string FormatNetworkCodeAssetKeyAdBreak(string networkCodeId, string assetKeyId, string adBreakId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	assetKeyId	The AssetKey ID. Must not be null or empty.
string	adBreakId	The AdBreak ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this AdBreakName with pattern networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}.

FromNetworkCodeAssetKeyAdBreak(string, string, string)

Creates a AdBreakName with the pattern networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}.

Declaration

public static AdBreakName FromNetworkCodeAssetKeyAdBreak(string networkCodeId, string assetKeyId, string adBreakId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	assetKeyId	The AssetKey ID. Must not be null or empty.
string	adBreakId	The AdBreak ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a AdBreakName containing an unparsed resource name.

Declaration

public static AdBreakName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
AdBreakName	A new instance of AdBreakName containing the provided unparsedResourceName.

GetHashCode()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

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

Declaration

public static AdBreakName Parse(string adBreakName)

Parameters

Type	Name	Description
string	adBreakName	The resource name in string form. Must not be null.

Returns

Type	Description
AdBreakName	The parsed AdBreakName if successful.

Remarks

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

• networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}

Parse(string, bool)

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

Declaration

public static AdBreakName Parse(string adBreakName, bool allowUnparsed)

Parameters

Type	Name	Description
string	adBreakName	The resource name in string form. Must not be null.
bool	allowUnparsed	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
AdBreakName	The parsed AdBreakName if successful.

Remarks

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

• networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

Implements

IResourceName.ToString()

TryParse(string, out AdBreakName)

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

Declaration

public static bool TryParse(string adBreakName, out AdBreakName result)

Parameters

Type	Name	Description
string	adBreakName	The resource name in string form. Must not be null.
AdBreakName	result	When this method returns, the parsed AdBreakName, 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:

• networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}

TryParse(string, bool, out AdBreakName)

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

Declaration

public static bool TryParse(string adBreakName, bool allowUnparsed, out AdBreakName result)

Parameters

Type	Name	Description
string	adBreakName	The resource name in string form. Must not be null.
bool	allowUnparsed	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.
AdBreakName	result	When this method returns, the parsed AdBreakName, 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:

• networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AdBreakName, AdBreakName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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