Class BreakTemplateName

Resource name for the BreakTemplate resource.

Inheritance

object

BreakTemplateName

Implements

IResourceName

IEquatable<BreakTemplateName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class BreakTemplateName : IResourceName, IEquatable<BreakTemplateName>

Constructors

BreakTemplateName(string, string)

Constructs a new instance of a BreakTemplateName class from the component parts of pattern networks/{network_code}/breakTemplates/{break_template}

Declaration

public BreakTemplateName(string networkCodeId, string breakTemplateId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	breakTemplateId	The BreakTemplate ID. Must not be null or empty.

Properties

BreakTemplateId

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

Declaration

public string BreakTemplateId { 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 BreakTemplateName.ResourceNameType of the contained resource name.

Declaration

public BreakTemplateName.ResourceNameType Type { get; }

Property Value

Type	Description
BreakTemplateName.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)

Formats the IDs into the string representation of this BreakTemplateName with pattern networks/{network_code}/breakTemplates/{break_template}.

Declaration

public static string Format(string networkCodeId, string breakTemplateId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	breakTemplateId	The BreakTemplate ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this BreakTemplateName with pattern networks/{network_code}/breakTemplates/{break_template}.

FormatNetworkCodeBreakTemplate(string, string)

Formats the IDs into the string representation of this BreakTemplateName with pattern networks/{network_code}/breakTemplates/{break_template}.

Declaration

public static string FormatNetworkCodeBreakTemplate(string networkCodeId, string breakTemplateId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	breakTemplateId	The BreakTemplate ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this BreakTemplateName with pattern networks/{network_code}/breakTemplates/{break_template}.

FromNetworkCodeBreakTemplate(string, string)

Creates a BreakTemplateName with the pattern networks/{network_code}/breakTemplates/{break_template}.

Declaration

public static BreakTemplateName FromNetworkCodeBreakTemplate(string networkCodeId, string breakTemplateId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	breakTemplateId	The BreakTemplate ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a BreakTemplateName containing an unparsed resource name.

Declaration

public static BreakTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
BreakTemplateName	A new instance of BreakTemplateName 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 BreakTemplateName instance.

Declaration

public static BreakTemplateName Parse(string breakTemplateName)

Parameters

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

Returns

Type	Description
BreakTemplateName	The parsed BreakTemplateName if successful.

Remarks

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

• networks/{network_code}/breakTemplates/{break_template}

Parse(string, bool)

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

Declaration

public static BreakTemplateName Parse(string breakTemplateName, bool allowUnparsed)

Parameters

Type	Name	Description
string	breakTemplateName	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
BreakTemplateName	The parsed BreakTemplateName if successful.

Remarks

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

• networks/{network_code}/breakTemplates/{break_template}

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

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

Declaration

public static bool TryParse(string breakTemplateName, out BreakTemplateName result)

Parameters

Type	Name	Description
string	breakTemplateName	The resource name in string form. Must not be null.
BreakTemplateName	result	When this method returns, the parsed BreakTemplateName, 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}/breakTemplates/{break_template}

TryParse(string, bool, out BreakTemplateName)

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

Declaration

public static bool TryParse(string breakTemplateName, bool allowUnparsed, out BreakTemplateName result)

Parameters

Type	Name	Description
string	breakTemplateName	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.
BreakTemplateName	result	When this method returns, the parsed BreakTemplateName, 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}/breakTemplates/{break_template}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(BreakTemplateName, BreakTemplateName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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