-
Notifications
You must be signed in to change notification settings - Fork 221
/
com.azure.resourcemanager.appservice.models.BackupSchedule.yml
174 lines (174 loc) · 13 KB
/
com.azure.resourcemanager.appservice.models.BackupSchedule.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
### YamlMime:JavaType
uid: "com.azure.resourcemanager.appservice.models.BackupSchedule"
fullName: "com.azure.resourcemanager.appservice.models.BackupSchedule"
name: "BackupSchedule"
nameWithType: "BackupSchedule"
summary: "Description of a backup schedule."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **BackupSchedule**"
constructors:
- uid: "com.azure.resourcemanager.appservice.models.BackupSchedule.BackupSchedule()"
fullName: "com.azure.resourcemanager.appservice.models.BackupSchedule.BackupSchedule()"
name: "BackupSchedule()"
nameWithType: "BackupSchedule.BackupSchedule()"
summary: "Creates an instance of Backup<wbr>Schedule class."
syntax: "public BackupSchedule()"
desc: "Creates an instance of BackupSchedule class."
methods:
- uid: "com.azure.resourcemanager.appservice.models.BackupSchedule.frequencyInterval()"
fullName: "com.azure.resourcemanager.appservice.models.BackupSchedule.frequencyInterval()"
name: "frequencyInterval()"
nameWithType: "BackupSchedule.frequencyInterval()"
summary: "Get the frequency<wbr>Interval property: How often the backup should be executed (e.<wbr>g."
syntax: "public int frequencyInterval()"
desc: "Get the frequencyInterval property: How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)."
returns:
description: "the frequencyInterval value."
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appservice.models.BackupSchedule.frequencyUnit()"
fullName: "com.azure.resourcemanager.appservice.models.BackupSchedule.frequencyUnit()"
name: "frequencyUnit()"
nameWithType: "BackupSchedule.frequencyUnit()"
summary: "Get the frequency<wbr>Unit property: The unit of time for how often the backup should be executed (e.<wbr>g."
syntax: "public FrequencyUnit frequencyUnit()"
desc: "Get the frequencyUnit property: The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)."
returns:
description: "the frequencyUnit value."
type: "<xref href=\"com.azure.resourcemanager.appservice.models.FrequencyUnit?alt=com.azure.resourcemanager.appservice.models.FrequencyUnit&text=FrequencyUnit\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appservice.models.BackupSchedule.keepAtLeastOneBackup()"
fullName: "com.azure.resourcemanager.appservice.models.BackupSchedule.keepAtLeastOneBackup()"
name: "keepAtLeastOneBackup()"
nameWithType: "BackupSchedule.keepAtLeastOneBackup()"
summary: "Get the keep<wbr>AtLeast<wbr>One<wbr>Backup property: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."
syntax: "public boolean keepAtLeastOneBackup()"
desc: "Get the keepAtLeastOneBackup property: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."
returns:
description: "the keepAtLeastOneBackup value."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appservice.models.BackupSchedule.lastExecutionTime()"
fullName: "com.azure.resourcemanager.appservice.models.BackupSchedule.lastExecutionTime()"
name: "lastExecutionTime()"
nameWithType: "BackupSchedule.lastExecutionTime()"
summary: "Get the last<wbr>Execution<wbr>Time property: Last time when this schedule was triggered."
syntax: "public OffsetDateTime lastExecutionTime()"
desc: "Get the lastExecutionTime property: Last time when this schedule was triggered."
returns:
description: "the lastExecutionTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.appservice.models.BackupSchedule.retentionPeriodInDays()"
fullName: "com.azure.resourcemanager.appservice.models.BackupSchedule.retentionPeriodInDays()"
name: "retentionPeriodInDays()"
nameWithType: "BackupSchedule.retentionPeriodInDays()"
summary: "Get the retention<wbr>Period<wbr>InDays property: After how many days backups should be deleted."
syntax: "public int retentionPeriodInDays()"
desc: "Get the retentionPeriodInDays property: After how many days backups should be deleted."
returns:
description: "the retentionPeriodInDays value."
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appservice.models.BackupSchedule.startTime()"
fullName: "com.azure.resourcemanager.appservice.models.BackupSchedule.startTime()"
name: "startTime()"
nameWithType: "BackupSchedule.startTime()"
summary: "Get the start<wbr>Time property: When the schedule should start working."
syntax: "public OffsetDateTime startTime()"
desc: "Get the startTime property: When the schedule should start working."
returns:
description: "the startTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.appservice.models.BackupSchedule.validate()"
fullName: "com.azure.resourcemanager.appservice.models.BackupSchedule.validate()"
name: "validate()"
nameWithType: "BackupSchedule.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.appservice.models.BackupSchedule.withFrequencyInterval(int)"
fullName: "com.azure.resourcemanager.appservice.models.BackupSchedule.withFrequencyInterval(int frequencyInterval)"
name: "withFrequencyInterval(int frequencyInterval)"
nameWithType: "BackupSchedule.withFrequencyInterval(int frequencyInterval)"
summary: "Set the frequency<wbr>Interval property: How often the backup should be executed (e.<wbr>g."
parameters:
- description: "the frequencyInterval value to set."
name: "frequencyInterval"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BackupSchedule withFrequencyInterval(int frequencyInterval)"
desc: "Set the frequencyInterval property: How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)."
returns:
description: "the BackupSchedule object itself."
type: "<xref href=\"com.azure.resourcemanager.appservice.models.BackupSchedule?alt=com.azure.resourcemanager.appservice.models.BackupSchedule&text=BackupSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appservice.models.BackupSchedule.withFrequencyUnit(com.azure.resourcemanager.appservice.models.FrequencyUnit)"
fullName: "com.azure.resourcemanager.appservice.models.BackupSchedule.withFrequencyUnit(FrequencyUnit frequencyUnit)"
name: "withFrequencyUnit(FrequencyUnit frequencyUnit)"
nameWithType: "BackupSchedule.withFrequencyUnit(FrequencyUnit frequencyUnit)"
summary: "Set the frequency<wbr>Unit property: The unit of time for how often the backup should be executed (e.<wbr>g."
parameters:
- description: "the frequencyUnit value to set."
name: "frequencyUnit"
type: "<xref href=\"com.azure.resourcemanager.appservice.models.FrequencyUnit?alt=com.azure.resourcemanager.appservice.models.FrequencyUnit&text=FrequencyUnit\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BackupSchedule withFrequencyUnit(FrequencyUnit frequencyUnit)"
desc: "Set the frequencyUnit property: The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)."
returns:
description: "the BackupSchedule object itself."
type: "<xref href=\"com.azure.resourcemanager.appservice.models.BackupSchedule?alt=com.azure.resourcemanager.appservice.models.BackupSchedule&text=BackupSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appservice.models.BackupSchedule.withKeepAtLeastOneBackup(boolean)"
fullName: "com.azure.resourcemanager.appservice.models.BackupSchedule.withKeepAtLeastOneBackup(boolean keepAtLeastOneBackup)"
name: "withKeepAtLeastOneBackup(boolean keepAtLeastOneBackup)"
nameWithType: "BackupSchedule.withKeepAtLeastOneBackup(boolean keepAtLeastOneBackup)"
summary: "Set the keep<wbr>AtLeast<wbr>One<wbr>Backup property: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."
parameters:
- description: "the keepAtLeastOneBackup value to set."
name: "keepAtLeastOneBackup"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BackupSchedule withKeepAtLeastOneBackup(boolean keepAtLeastOneBackup)"
desc: "Set the keepAtLeastOneBackup property: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."
returns:
description: "the BackupSchedule object itself."
type: "<xref href=\"com.azure.resourcemanager.appservice.models.BackupSchedule?alt=com.azure.resourcemanager.appservice.models.BackupSchedule&text=BackupSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appservice.models.BackupSchedule.withRetentionPeriodInDays(int)"
fullName: "com.azure.resourcemanager.appservice.models.BackupSchedule.withRetentionPeriodInDays(int retentionPeriodInDays)"
name: "withRetentionPeriodInDays(int retentionPeriodInDays)"
nameWithType: "BackupSchedule.withRetentionPeriodInDays(int retentionPeriodInDays)"
summary: "Set the retention<wbr>Period<wbr>InDays property: After how many days backups should be deleted."
parameters:
- description: "the retentionPeriodInDays value to set."
name: "retentionPeriodInDays"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BackupSchedule withRetentionPeriodInDays(int retentionPeriodInDays)"
desc: "Set the retentionPeriodInDays property: After how many days backups should be deleted."
returns:
description: "the BackupSchedule object itself."
type: "<xref href=\"com.azure.resourcemanager.appservice.models.BackupSchedule?alt=com.azure.resourcemanager.appservice.models.BackupSchedule&text=BackupSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appservice.models.BackupSchedule.withStartTime(java.time.OffsetDateTime)"
fullName: "com.azure.resourcemanager.appservice.models.BackupSchedule.withStartTime(OffsetDateTime startTime)"
name: "withStartTime(OffsetDateTime startTime)"
nameWithType: "BackupSchedule.withStartTime(OffsetDateTime startTime)"
summary: "Set the start<wbr>Time property: When the schedule should start working."
parameters:
- description: "the startTime value to set."
name: "startTime"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public BackupSchedule withStartTime(OffsetDateTime startTime)"
desc: "Set the startTime property: When the schedule should start working."
returns:
description: "the BackupSchedule object itself."
type: "<xref href=\"com.azure.resourcemanager.appservice.models.BackupSchedule?alt=com.azure.resourcemanager.appservice.models.BackupSchedule&text=BackupSchedule\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."
metadata: {}
package: "com.azure.resourcemanager.appservice.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-appservice:2.39.0