/
com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.yml
116 lines (116 loc) · 8.37 KB
/
com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.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
### YamlMime:JavaType
uid: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo"
fullName: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo"
name: "PeriodicTimerSourceInfo"
nameWithType: "PeriodicTimerSourceInfo"
summary: "Periodic timer event source."
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 **PeriodicTimerSourceInfo**"
constructors:
- uid: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.PeriodicTimerSourceInfo()"
fullName: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.PeriodicTimerSourceInfo()"
name: "PeriodicTimerSourceInfo()"
nameWithType: "PeriodicTimerSourceInfo.PeriodicTimerSourceInfo()"
summary: "Creates an instance of Periodic<wbr>Timer<wbr>Source<wbr>Info class."
syntax: "public PeriodicTimerSourceInfo()"
desc: "Creates an instance of PeriodicTimerSourceInfo class."
methods:
- uid: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.schedule()"
fullName: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.schedule()"
name: "schedule()"
nameWithType: "PeriodicTimerSourceInfo.schedule()"
summary: "Get the schedule property: Periodic frequency at which timer event needs to be raised."
syntax: "public String schedule()"
desc: "Get the schedule property: Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds."
returns:
description: "the schedule value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.startTime()"
fullName: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.startTime()"
name: "startTime()"
nameWithType: "PeriodicTimerSourceInfo.startTime()"
summary: "Get the start<wbr>Time property: The time of the day that results in a valid trigger."
syntax: "public OffsetDateTime startTime()"
desc: "Get the startTime property: The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time."
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.databoxedge.models.PeriodicTimerSourceInfo.topic()"
fullName: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.topic()"
name: "topic()"
nameWithType: "PeriodicTimerSourceInfo.topic()"
summary: "Get the topic property: Topic where periodic events are published to IoT device."
syntax: "public String topic()"
desc: "Get the topic property: Topic where periodic events are published to IoT device."
returns:
description: "the topic value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.validate()"
fullName: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.validate()"
name: "validate()"
nameWithType: "PeriodicTimerSourceInfo.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.withSchedule(java.lang.String)"
fullName: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.withSchedule(String schedule)"
name: "withSchedule(String schedule)"
nameWithType: "PeriodicTimerSourceInfo.withSchedule(String schedule)"
summary: "Set the schedule property: Periodic frequency at which timer event needs to be raised."
parameters:
- description: "the schedule value to set."
name: "schedule"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PeriodicTimerSourceInfo withSchedule(String schedule)"
desc: "Set the schedule property: Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds."
returns:
description: "the PeriodicTimerSourceInfo object itself."
type: "<xref href=\"com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo?alt=com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo&text=PeriodicTimerSourceInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.withStartTime(java.time.OffsetDateTime)"
fullName: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.withStartTime(OffsetDateTime startTime)"
name: "withStartTime(OffsetDateTime startTime)"
nameWithType: "PeriodicTimerSourceInfo.withStartTime(OffsetDateTime startTime)"
summary: "Set the start<wbr>Time property: The time of the day that results in a valid trigger."
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 PeriodicTimerSourceInfo withStartTime(OffsetDateTime startTime)"
desc: "Set the startTime property: The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time."
returns:
description: "the PeriodicTimerSourceInfo object itself."
type: "<xref href=\"com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo?alt=com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo&text=PeriodicTimerSourceInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.withTopic(java.lang.String)"
fullName: "com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo.withTopic(String topic)"
name: "withTopic(String topic)"
nameWithType: "PeriodicTimerSourceInfo.withTopic(String topic)"
summary: "Set the topic property: Topic where periodic events are published to IoT device."
parameters:
- description: "the topic value to set."
name: "topic"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PeriodicTimerSourceInfo withTopic(String topic)"
desc: "Set the topic property: Topic where periodic events are published to IoT device."
returns:
description: "the PeriodicTimerSourceInfo object itself."
type: "<xref href=\"com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo?alt=com.azure.resourcemanager.databoxedge.models.PeriodicTimerSourceInfo&text=PeriodicTimerSourceInfo\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Periodic timer event source."
metadata: {}
package: "com.azure.resourcemanager.databoxedge.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-databoxedge:1.0.0-beta.2