• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1"""Generated message classes for dns version v1.
2
3The Google Cloud DNS API provides services for configuring and serving
4authoritative DNS records.
5"""
6# NOTE: This file is autogenerated and should not be edited by hand.
7
8from apitools.base.protorpclite import messages as _messages
9
10
11package = 'dns'
12
13
14class Change(_messages.Message):
15  r"""An atomic update to a collection of ResourceRecordSets.
16
17  Enums:
18    StatusValueValuesEnum: Status of the operation (output only).
19
20  Fields:
21    additions: Which ResourceRecordSets to add?
22    deletions: Which ResourceRecordSets to remove? Must match existing data
23      exactly.
24    id: Unique identifier for the resource; defined by the server (output
25      only).
26    kind: Identifies what kind of resource this is. Value: the fixed string
27      "dns#change".
28    startTime: The time that this operation was started by the server. This is
29      in RFC3339 text format.
30    status: Status of the operation (output only).
31  """
32
33  class StatusValueValuesEnum(_messages.Enum):
34    r"""Status of the operation (output only).
35
36    Values:
37      done: <no description>
38      pending: <no description>
39    """
40    done = 0
41    pending = 1
42
43  additions = _messages.MessageField('ResourceRecordSet', 1, repeated=True)
44  deletions = _messages.MessageField('ResourceRecordSet', 2, repeated=True)
45  id = _messages.StringField(3)
46  kind = _messages.StringField(4, default=u'dns#change')
47  startTime = _messages.StringField(5)
48  status = _messages.EnumField('StatusValueValuesEnum', 6)
49
50
51class ChangesListResponse(_messages.Message):
52  r"""The response to a request to enumerate Changes to a ResourceRecordSets
53  collection.
54
55  Fields:
56    changes: The requested changes.
57    kind: Type of resource.
58    nextPageToken: The presence of this field indicates that there exist more
59      results following your last page of results in pagination order. To
60      fetch them, make another list request using this value as your
61      pagination token.  In this way you can retrieve the complete contents of
62      even very large collections one page at a time. However, if the contents
63      of the collection change between the first and last paginated list
64      request, the set of all elements returned will be an inconsistent view
65      of the collection. There is no way to retrieve a "snapshot" of
66      collections larger than the maximum page size.
67  """
68
69  changes = _messages.MessageField('Change', 1, repeated=True)
70  kind = _messages.StringField(2, default=u'dns#changesListResponse')
71  nextPageToken = _messages.StringField(3)
72
73
74class DnsChangesCreateRequest(_messages.Message):
75  r"""A DnsChangesCreateRequest object.
76
77  Fields:
78    change: A Change resource to be passed as the request body.
79    managedZone: Identifies the managed zone addressed by this request. Can be
80      the managed zone name or id.
81    project: Identifies the project addressed by this request.
82  """
83
84  change = _messages.MessageField('Change', 1)
85  managedZone = _messages.StringField(2, required=True)
86  project = _messages.StringField(3, required=True)
87
88
89class DnsChangesGetRequest(_messages.Message):
90  r"""A DnsChangesGetRequest object.
91
92  Fields:
93    changeId: The identifier of the requested change, from a previous
94      ResourceRecordSetsChangeResponse.
95    managedZone: Identifies the managed zone addressed by this request. Can be
96      the managed zone name or id.
97    project: Identifies the project addressed by this request.
98  """
99
100  changeId = _messages.StringField(1, required=True)
101  managedZone = _messages.StringField(2, required=True)
102  project = _messages.StringField(3, required=True)
103
104
105class DnsChangesListRequest(_messages.Message):
106  r"""A DnsChangesListRequest object.
107
108  Enums:
109    SortByValueValuesEnum: Sorting criterion. The only supported value is
110      change sequence.
111
112  Fields:
113    managedZone: Identifies the managed zone addressed by this request. Can be
114      the managed zone name or id.
115    maxResults: Optional. Maximum number of results to be returned. If
116      unspecified, the server will decide how many results to return.
117    pageToken: Optional. A tag returned by a previous list request that was
118      truncated. Use this parameter to continue a previous list request.
119    project: Identifies the project addressed by this request.
120    sortBy: Sorting criterion. The only supported value is change sequence.
121    sortOrder: Sorting order direction: 'ascending' or 'descending'.
122  """
123
124  class SortByValueValuesEnum(_messages.Enum):
125    r"""Sorting criterion. The only supported value is change sequence.
126
127    Values:
128      changeSequence: <no description>
129    """
130    changeSequence = 0
131
132  managedZone = _messages.StringField(1, required=True)
133  maxResults = _messages.IntegerField(2, variant=_messages.Variant.INT32)
134  pageToken = _messages.StringField(3)
135  project = _messages.StringField(4, required=True)
136  sortBy = _messages.EnumField('SortByValueValuesEnum', 5, default=u'changeSequence')
137  sortOrder = _messages.StringField(6)
138
139
140class DnsManagedZonesCreateRequest(_messages.Message):
141  r"""A DnsManagedZonesCreateRequest object.
142
143  Fields:
144    managedZone: A ManagedZone resource to be passed as the request body.
145    project: Identifies the project addressed by this request.
146  """
147
148  managedZone = _messages.MessageField('ManagedZone', 1)
149  project = _messages.StringField(2, required=True)
150
151
152class DnsManagedZonesDeleteRequest(_messages.Message):
153  r"""A DnsManagedZonesDeleteRequest object.
154
155  Fields:
156    managedZone: Identifies the managed zone addressed by this request. Can be
157      the managed zone name or id.
158    project: Identifies the project addressed by this request.
159  """
160
161  managedZone = _messages.StringField(1, required=True)
162  project = _messages.StringField(2, required=True)
163
164
165class DnsManagedZonesDeleteResponse(_messages.Message):
166  r"""An empty DnsManagedZonesDelete response."""
167
168
169class DnsManagedZonesGetRequest(_messages.Message):
170  r"""A DnsManagedZonesGetRequest object.
171
172  Fields:
173    managedZone: Identifies the managed zone addressed by this request. Can be
174      the managed zone name or id.
175    project: Identifies the project addressed by this request.
176  """
177
178  managedZone = _messages.StringField(1, required=True)
179  project = _messages.StringField(2, required=True)
180
181
182class DnsManagedZonesListRequest(_messages.Message):
183  r"""A DnsManagedZonesListRequest object.
184
185  Fields:
186    dnsName: Restricts the list to return only zones with this domain name.
187    maxResults: Optional. Maximum number of results to be returned. If
188      unspecified, the server will decide how many results to return.
189    pageToken: Optional. A tag returned by a previous list request that was
190      truncated. Use this parameter to continue a previous list request.
191    project: Identifies the project addressed by this request.
192  """
193
194  dnsName = _messages.StringField(1)
195  maxResults = _messages.IntegerField(2, variant=_messages.Variant.INT32)
196  pageToken = _messages.StringField(3)
197  project = _messages.StringField(4, required=True)
198
199
200class DnsProjectsGetRequest(_messages.Message):
201  r"""A DnsProjectsGetRequest object.
202
203  Fields:
204    project: Identifies the project addressed by this request.
205  """
206
207  project = _messages.StringField(1, required=True)
208
209
210class DnsResourceRecordSetsListRequest(_messages.Message):
211  r"""A DnsResourceRecordSetsListRequest object.
212
213  Fields:
214    managedZone: Identifies the managed zone addressed by this request. Can be
215      the managed zone name or id.
216    maxResults: Optional. Maximum number of results to be returned. If
217      unspecified, the server will decide how many results to return.
218    name: Restricts the list to return only records with this fully qualified
219      domain name.
220    pageToken: Optional. A tag returned by a previous list request that was
221      truncated. Use this parameter to continue a previous list request.
222    project: Identifies the project addressed by this request.
223    type: Restricts the list to return only records of this type. If present,
224      the "name" parameter must also be present.
225  """
226
227  managedZone = _messages.StringField(1, required=True)
228  maxResults = _messages.IntegerField(2, variant=_messages.Variant.INT32)
229  name = _messages.StringField(3)
230  pageToken = _messages.StringField(4)
231  project = _messages.StringField(5, required=True)
232  type = _messages.StringField(6)
233
234
235class ManagedZone(_messages.Message):
236  r"""A zone is a subtree of the DNS namespace under one administrative
237  responsibility. A ManagedZone is a resource that represents a DNS zone
238  hosted by the Cloud DNS service.
239
240  Fields:
241    creationTime: The time that this resource was created on the server. This
242      is in RFC3339 text format. Output only.
243    description: A mutable string of at most 1024 characters associated with
244      this resource for the user's convenience. Has no effect on the managed
245      zone's function.
246    dnsName: The DNS name of this managed zone, for instance "example.com.".
247    id: Unique identifier for the resource; defined by the server (output
248      only)
249    kind: Identifies what kind of resource this is. Value: the fixed string
250      "dns#managedZone".
251    name: User assigned name for this resource. Must be unique within the
252      project. The name must be 1-32 characters long, must begin with a
253      letter, end with a letter or digit, and only contain lowercase letters,
254      digits or dashes.
255    nameServerSet: Optionally specifies the NameServerSet for this
256      ManagedZone. A NameServerSet is a set of DNS name servers that all host
257      the same ManagedZones. Most users will leave this field unset.
258    nameServers: Delegate your managed_zone to these virtual name servers;
259      defined by the server (output only)
260  """
261
262  creationTime = _messages.StringField(1)
263  description = _messages.StringField(2)
264  dnsName = _messages.StringField(3)
265  id = _messages.IntegerField(4, variant=_messages.Variant.UINT64)
266  kind = _messages.StringField(5, default=u'dns#managedZone')
267  name = _messages.StringField(6)
268  nameServerSet = _messages.StringField(7)
269  nameServers = _messages.StringField(8, repeated=True)
270
271
272class ManagedZonesListResponse(_messages.Message):
273  r"""A ManagedZonesListResponse object.
274
275  Fields:
276    kind: Type of resource.
277    managedZones: The managed zone resources.
278    nextPageToken: The presence of this field indicates that there exist more
279      results following your last page of results in pagination order. To
280      fetch them, make another list request using this value as your page
281      token.  In this way you can retrieve the complete contents of even very
282      large collections one page at a time. However, if the contents of the
283      collection change between the first and last paginated list request, the
284      set of all elements returned will be an inconsistent view of the
285      collection. There is no way to retrieve a consistent snapshot of a
286      collection larger than the maximum page size.
287  """
288
289  kind = _messages.StringField(1, default=u'dns#managedZonesListResponse')
290  managedZones = _messages.MessageField('ManagedZone', 2, repeated=True)
291  nextPageToken = _messages.StringField(3)
292
293
294class Project(_messages.Message):
295  r"""A project resource. The project is a top level container for resources
296  including Cloud DNS ManagedZones. Projects can be created only in the APIs
297  console.
298
299  Fields:
300    id: User assigned unique identifier for the resource (output only).
301    kind: Identifies what kind of resource this is. Value: the fixed string
302      "dns#project".
303    number: Unique numeric identifier for the resource; defined by the server
304      (output only).
305    quota: Quotas assigned to this project (output only).
306  """
307
308  id = _messages.StringField(1)
309  kind = _messages.StringField(2, default=u'dns#project')
310  number = _messages.IntegerField(3, variant=_messages.Variant.UINT64)
311  quota = _messages.MessageField('Quota', 4)
312
313
314class Quota(_messages.Message):
315  r"""Limits associated with a Project.
316
317  Fields:
318    kind: Identifies what kind of resource this is. Value: the fixed string
319      "dns#quota".
320    managedZones: Maximum allowed number of managed zones in the project.
321    resourceRecordsPerRrset: Maximum allowed number of ResourceRecords per
322      ResourceRecordSet.
323    rrsetAdditionsPerChange: Maximum allowed number of ResourceRecordSets to
324      add per ChangesCreateRequest.
325    rrsetDeletionsPerChange: Maximum allowed number of ResourceRecordSets to
326      delete per ChangesCreateRequest.
327    rrsetsPerManagedZone: Maximum allowed number of ResourceRecordSets per
328      zone in the project.
329    totalRrdataSizePerChange: Maximum allowed size for total rrdata in one
330      ChangesCreateRequest in bytes.
331  """
332
333  kind = _messages.StringField(1, default=u'dns#quota')
334  managedZones = _messages.IntegerField(2, variant=_messages.Variant.INT32)
335  resourceRecordsPerRrset = _messages.IntegerField(3, variant=_messages.Variant.INT32)
336  rrsetAdditionsPerChange = _messages.IntegerField(4, variant=_messages.Variant.INT32)
337  rrsetDeletionsPerChange = _messages.IntegerField(5, variant=_messages.Variant.INT32)
338  rrsetsPerManagedZone = _messages.IntegerField(6, variant=_messages.Variant.INT32)
339  totalRrdataSizePerChange = _messages.IntegerField(7, variant=_messages.Variant.INT32)
340
341
342class ResourceRecordSet(_messages.Message):
343  r"""A unit of data that will be returned by the DNS servers.
344
345  Fields:
346    kind: Identifies what kind of resource this is. Value: the fixed string
347      "dns#resourceRecordSet".
348    name: For example, www.example.com.
349    rrdatas: As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
350    ttl: Number of seconds that this ResourceRecordSet can be cached by
351      resolvers.
352    type: The identifier of a supported record type, for example, A, AAAA, MX,
353      TXT, and so on.
354  """
355
356  kind = _messages.StringField(1, default=u'dns#resourceRecordSet')
357  name = _messages.StringField(2)
358  rrdatas = _messages.StringField(3, repeated=True)
359  ttl = _messages.IntegerField(4, variant=_messages.Variant.INT32)
360  type = _messages.StringField(5)
361
362
363class ResourceRecordSetsListResponse(_messages.Message):
364  r"""A ResourceRecordSetsListResponse object.
365
366  Fields:
367    kind: Type of resource.
368    nextPageToken: The presence of this field indicates that there exist more
369      results following your last page of results in pagination order. To
370      fetch them, make another list request using this value as your
371      pagination token.  In this way you can retrieve the complete contents of
372      even very large collections one page at a time. However, if the contents
373      of the collection change between the first and last paginated list
374      request, the set of all elements returned will be an inconsistent view
375      of the collection. There is no way to retrieve a consistent snapshot of
376      a collection larger than the maximum page size.
377    rrsets: The resource record set resources.
378  """
379
380  kind = _messages.StringField(1, default=u'dns#resourceRecordSetsListResponse')
381  nextPageToken = _messages.StringField(2)
382  rrsets = _messages.MessageField('ResourceRecordSet', 3, repeated=True)
383
384
385class StandardQueryParameters(_messages.Message):
386  r"""Query parameters accepted by all methods.
387
388  Enums:
389    AltValueValuesEnum: Data format for the response.
390
391  Fields:
392    alt: Data format for the response.
393    fields: Selector specifying which fields to include in a partial response.
394    key: API key. Your API key identifies your project and provides you with
395      API access, quota, and reports. Required unless you provide an OAuth 2.0
396      token.
397    oauth_token: OAuth 2.0 token for the current user.
398    prettyPrint: Returns response with indentations and line breaks.
399    quotaUser: Available to use for quota purposes for server-side
400      applications. Can be any arbitrary string assigned to a user, but should
401      not exceed 40 characters. Overrides userIp if both are provided.
402    trace: A tracing token of the form "token:<tokenid>" to include in api
403      requests.
404    userIp: IP address of the site where the request originates. Use this if
405      you want to enforce per-user limits.
406  """
407
408  class AltValueValuesEnum(_messages.Enum):
409    r"""Data format for the response.
410
411    Values:
412      json: Responses with Content-Type of application/json
413    """
414    json = 0
415
416  alt = _messages.EnumField('AltValueValuesEnum', 1, default=u'json')
417  fields = _messages.StringField(2)
418  key = _messages.StringField(3)
419  oauth_token = _messages.StringField(4)
420  prettyPrint = _messages.BooleanField(5, default=True)
421  quotaUser = _messages.StringField(6)
422  trace = _messages.StringField(7)
423  userIp = _messages.StringField(8)
424
425
426