/
com.azure.search.documents.indexes.models.IndexingSchedule.yml
108 lines (108 loc) · 7.7 KB
/
com.azure.search.documents.indexes.models.IndexingSchedule.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
### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.IndexingSchedule"
fullName: "com.azure.search.documents.indexes.models.IndexingSchedule"
name: "IndexingSchedule"
nameWithType: "IndexingSchedule"
summary: "Represents a schedule for indexer execution."
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 **IndexingSchedule**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.models.IndexingSchedule?alt=com.azure.search.documents.indexes.models.IndexingSchedule&text=IndexingSchedule\" data-throw-if-not-resolved=\"False\" />>"
constructors:
- uid: "com.azure.search.documents.indexes.models.IndexingSchedule.IndexingSchedule(java.time.Duration)"
fullName: "com.azure.search.documents.indexes.models.IndexingSchedule.IndexingSchedule(Duration interval)"
name: "IndexingSchedule(Duration interval)"
nameWithType: "IndexingSchedule.IndexingSchedule(Duration interval)"
summary: "Creates an instance of Indexing<wbr>Schedule class."
parameters:
- description: "the interval value to set."
name: "interval"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
syntax: "public IndexingSchedule(Duration interval)"
desc: "Creates an instance of IndexingSchedule class."
methods:
- uid: "com.azure.search.documents.indexes.models.IndexingSchedule.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.search.documents.indexes.models.IndexingSchedule.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "IndexingSchedule.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Indexing<wbr>Schedule from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static IndexingSchedule fromJson(JsonReader jsonReader)"
exceptions:
- description: "If the deserialized JSON object was missing any required properties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of IndexingSchedule from the JsonReader."
returns:
description: "An instance of IndexingSchedule if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.search.documents.indexes.models.IndexingSchedule?alt=com.azure.search.documents.indexes.models.IndexingSchedule&text=IndexingSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.IndexingSchedule.getInterval()"
fullName: "com.azure.search.documents.indexes.models.IndexingSchedule.getInterval()"
name: "getInterval()"
nameWithType: "IndexingSchedule.getInterval()"
summary: "Get the interval property: The interval of time between indexer executions."
syntax: "public Duration getInterval()"
desc: "Get the interval property: The interval of time between indexer executions."
returns:
description: "the interval value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.search.documents.indexes.models.IndexingSchedule.getStartTime()"
fullName: "com.azure.search.documents.indexes.models.IndexingSchedule.getStartTime()"
name: "getStartTime()"
nameWithType: "IndexingSchedule.getStartTime()"
summary: "Get the start<wbr>Time property: The time when an indexer should start running."
syntax: "public OffsetDateTime getStartTime()"
desc: "Get the startTime property: The time when an indexer should start running."
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.search.documents.indexes.models.IndexingSchedule.setStartTime(java.time.OffsetDateTime)"
fullName: "com.azure.search.documents.indexes.models.IndexingSchedule.setStartTime(OffsetDateTime startTime)"
name: "setStartTime(OffsetDateTime startTime)"
nameWithType: "IndexingSchedule.setStartTime(OffsetDateTime startTime)"
summary: "Set the start<wbr>Time property: The time when an indexer should start running."
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 IndexingSchedule setStartTime(OffsetDateTime startTime)"
desc: "Set the startTime property: The time when an indexer should start running."
returns:
description: "the IndexingSchedule object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.IndexingSchedule?alt=com.azure.search.documents.indexes.models.IndexingSchedule&text=IndexingSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.IndexingSchedule.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.search.documents.indexes.models.IndexingSchedule.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "IndexingSchedule.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Represents a schedule for indexer execution."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.models.IndexingSchedule?alt=com.azure.search.documents.indexes.models.IndexingSchedule&text=IndexingSchedule\" data-throw-if-not-resolved=\"False\" />>"
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.6.4