BreakTemplate (Ad Manager Axis classes 4.9.0 API)

java.lang.Object
- com.google.api.ads.admanager.axis.v202002.BreakTemplate

All Implemented Interfaces:

Serializable
```
public class BreakTemplate
extends Object
implements Serializable
```
A BreakTemplate defines what kinds of ads show at which positions within a pod.
Break templates are made up of AdSpot objects. A break template must have a single ad spot that has AdSpot#flexible set to true.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`BreakTemplate()`
`BreakTemplate(Long id, Boolean customTemplate, String name, String displayName, BreakTemplateBreakTemplateMember[] breakTemplateMembers)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`BreakTemplateBreakTemplateMember[]`	`getBreakTemplateMembers()` Gets the breakTemplateMembers value for this BreakTemplate.
`BreakTemplateBreakTemplateMember`	`getBreakTemplateMembers(int i)`
`Boolean`	`getCustomTemplate()` Gets the customTemplate value for this BreakTemplate.
`static org.apache.axis.encoding.Deserializer`	`getDeserializer(String mechType, Class _javaType, QName _xmlType)` Get Custom Deserializer
`String`	`getDisplayName()` Gets the displayName value for this BreakTemplate.
`Long`	`getId()` Gets the id value for this BreakTemplate.
`String`	`getName()` Gets the name value for this BreakTemplate.
`static org.apache.axis.encoding.Serializer`	`getSerializer(String mechType, Class _javaType, QName _xmlType)` Get Custom Serializer
`static org.apache.axis.description.TypeDesc`	`getTypeDesc()` Return type metadata object
`int`	`hashCode()`
`void`	`setBreakTemplateMembers(BreakTemplateBreakTemplateMember[] breakTemplateMembers)` Sets the breakTemplateMembers value for this BreakTemplate.
`void`	`setBreakTemplateMembers(int i, BreakTemplateBreakTemplateMember _value)`
`void`	`setCustomTemplate(Boolean customTemplate)` Sets the customTemplate value for this BreakTemplate.
`void`	`setDisplayName(String displayName)` Sets the displayName value for this BreakTemplate.
`void`	`setId(Long id)` Sets the id value for this BreakTemplate.
`void`	`setName(String name)` Sets the name value for this BreakTemplate.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BreakTemplate
```
public BreakTemplate()
```
  - BreakTemplate
```
public BreakTemplate(Long id,
                     Boolean customTemplate,
                     String name,
                     String displayName,
                     BreakTemplateBreakTemplateMember[] breakTemplateMembers)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getId
```
public Long getId()
```
    Gets the id value for this BreakTemplate.
    
    Returns:
    
    id * The unique ID of the BreakTemplate. This value is readonly and is assigned by Google.
  - setId
```
public void setId(Long id)
```
    Sets the id value for this BreakTemplate.
    
    Parameters:
    
    id - * The unique ID of the BreakTemplate. This value is readonly and is assigned by Google.
  - getCustomTemplate
```
public Boolean getCustomTemplate()
```
    Gets the customTemplate value for this BreakTemplate.
    
    Returns:
    
    customTemplate * Whether this is custom template. Custom templates get created outside of the ad rule workflow and can be referenced in ad tags.
    Only custom templates can have names and display names.
  - setCustomTemplate
```
public void setCustomTemplate(Boolean customTemplate)
```
    Sets the customTemplate value for this BreakTemplate.
    
    Parameters:
    
    customTemplate - * Whether this is custom template. Custom templates get created outside of the ad rule workflow and can be referenced in ad tags.
    Only custom templates can have names and display names.
  - getName
```
public String getName()
```
    Gets the name value for this BreakTemplate.
    
    Returns:
    
    name * Name of the BreakTemplate. The name is case insenstive and can be referenced in ad tags. This value is required if customTemplate is true, and cannot be set otherwise.
    You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
  - setName
```
public void setName(String name)
```
    Sets the name value for this BreakTemplate.
    
    Parameters:
    
    name - * Name of the BreakTemplate. The name is case insenstive and can be referenced in ad tags. This value is required if customTemplate is true, and cannot be set otherwise.
    You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
  - getDisplayName
```
public String getDisplayName()
```
    Gets the displayName value for this BreakTemplate.
    
    Returns:
    
    displayName * Descriptive name for the BreakTemplateDto. This value is optional if customTemplate is true, and cannot be set otherwise.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Sets the displayName value for this BreakTemplate.
    
    Parameters:
    
    displayName - * Descriptive name for the BreakTemplateDto. This value is optional if customTemplate is true, and cannot be set otherwise.
  - getBreakTemplateMembers
```
public BreakTemplateBreakTemplateMember[] getBreakTemplateMembers()
```
    Gets the breakTemplateMembers value for this BreakTemplate.
    
    Returns:
    
    breakTemplateMembers * The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to a AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.
  - setBreakTemplateMembers
```
public void setBreakTemplateMembers(BreakTemplateBreakTemplateMember[] breakTemplateMembers)
```
    Sets the breakTemplateMembers value for this BreakTemplate.
    
    Parameters:
    
    breakTemplateMembers - * The list of the BreakTemplateMember objects in the order in which they should appear in the ad pod. Each BreakTemplateMember has a reference to a AdSpot, which defines what kinds of ads can appear at that position, as well as other metadata that defines how each ad spot should be filled.
  - getBreakTemplateMembers
```
public BreakTemplateBreakTemplateMember getBreakTemplateMembers(int i)
```
  - setBreakTemplateMembers
```
public void setBreakTemplateMembers(int i,
                                    BreakTemplateBreakTemplateMember _value)
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getTypeDesc
```
public static org.apache.axis.description.TypeDesc getTypeDesc()
```
    Return type metadata object
  - getSerializer
```
public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)
```
    Get Custom Serializer
  - getDeserializer
```
public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)
```
    Get Custom Deserializer

Class BreakTemplate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BreakTemplate

BreakTemplate

Method Detail

toString

getId

setId

getCustomTemplate

setCustomTemplate

getName

setName

getDisplayName

setDisplayName

getBreakTemplateMembers

setBreakTemplateMembers

getBreakTemplateMembers

setBreakTemplateMembers

equals

hashCode

getTypeDesc

getSerializer

getDeserializer