1"""Generated message classes for composerflex version v1alpha1.
2
3Manages workflows on Google Cloud Platform using Apache Airflow. Composer Flex
4additionally provides per-workflow security, auto-scaling, and native GCP
5tooling for workflows and tasks.
6"""
7# NOTE: This file is autogenerated and should not be edited by hand.
8
9from __future__ import absolute_import
10
11from apitools.base.protorpclite import messages as _messages
12from apitools.base.py import encoding
13from apitools.base.py import extra_types
14
15
16package = 'composerflex'
17
18
19class AirflowDag(_messages.Message):
20  r"""A specification of an Apache Airflow DAG.
21
22  Fields:
23    data: The contents of a Python module or ZIP archive that specifies an
24      Airflow DAG.
25  """
26
27  data = _messages.BytesField(1)
28
29
30class ComposerflexProjectsLocationsContextsCreateRequest(_messages.Message):
31  r"""A ComposerflexProjectsLocationsContextsCreateRequest object.
32
33  Fields:
34    context: A Context resource to be passed as the request body.
35    parent: Parent resource of the context to create. The parent must be of
36      the form "projects/{projectId}/locations/{locationId}".
37  """
38
39  context = _messages.MessageField('Context', 1)
40  parent = _messages.StringField(2, required=True)
41
42
43class ComposerflexProjectsLocationsContextsDeleteRequest(_messages.Message):
44  r"""A ComposerflexProjectsLocationsContextsDeleteRequest object.
45
46  Fields:
47    name: The resource name of the context to delete. Must be in the form
48      "projects/{projectId}/locations/{locationId}/contexts/{contextId}."
49  """
50
51  name = _messages.StringField(1, required=True)
52
53
54class ComposerflexProjectsLocationsContextsGetRequest(_messages.Message):
55  r"""A ComposerflexProjectsLocationsContextsGetRequest object.
56
57  Fields:
58    name: The resource name of the context to retrieve. Must be in the form
59      "projects/{projectId}/locations/{locationId}/contexts/{contextId}."
60  """
61
62  name = _messages.StringField(1, required=True)
63
64
65class ComposerflexProjectsLocationsContextsListRequest(_messages.Message):
66  r"""A ComposerflexProjectsLocationsContextsListRequest object.
67
68  Fields:
69    filter: Filter will remain internal until its future implementation.
70    orderBy: Optional. Specifies the ordering of results following syntax at
71      https://cloud.google.com/apis/design/design_patterns#sorting_order.
72      Order by will remain internal until its future implementation.
73    pageSize: The maximum number of contexts to return.
74    pageToken: Optional. The next_page_token returned from a previous List
75      request.
76    parent: List contexts in the given parent resource. Parent must be in the
77      form "projects/{projectId}/locations/{locationId}".
78  """
79
80  filter = _messages.StringField(1)
81  orderBy = _messages.StringField(2)
82  pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32)
83  pageToken = _messages.StringField(4)
84  parent = _messages.StringField(5, required=True)
85
86
87class ComposerflexProjectsLocationsWorkflowsCreateRequest(_messages.Message):
88  r"""A ComposerflexProjectsLocationsWorkflowsCreateRequest object.
89
90  Fields:
91    parent: Parent resource of the workflow to create. The parent must be of
92      the form "projects/{projectId}/locations/{locationId}".
93    workflow: A Workflow resource to be passed as the request body.
94  """
95
96  parent = _messages.StringField(1, required=True)
97  workflow = _messages.MessageField('Workflow', 2)
98
99
100class ComposerflexProjectsLocationsWorkflowsDeleteRequest(_messages.Message):
101  r"""A ComposerflexProjectsLocationsWorkflowsDeleteRequest object.
102
103  Fields:
104    name: The resource name of the workflow to delete. Must be in the form
105      "projects/{projectId}/locations/{locationId}/workflows/{workflowId}."
106  """
107
108  name = _messages.StringField(1, required=True)
109
110
111class ComposerflexProjectsLocationsWorkflowsGetRequest(_messages.Message):
112  r"""A ComposerflexProjectsLocationsWorkflowsGetRequest object.
113
114  Fields:
115    name: The resource name of the workflow to retrieve. Must be in the form
116      "projects/{projectId}/locations/{locationId}/workflows/{workflowId}."
117  """
118
119  name = _messages.StringField(1, required=True)
120
121
122class ComposerflexProjectsLocationsWorkflowsListRequest(_messages.Message):
123  r"""A ComposerflexProjectsLocationsWorkflowsListRequest object.
124
125  Fields:
126    filter: Filter will remain internal until its future implementation.
127    orderBy: Optional. Specifies the ordering of results following syntax at
128      https://cloud.google.com/apis/design/design_patterns#sorting_order.
129      Order by will remain internal until its future implementation.
130    pageSize: The maximum number of workflows to return.
131    pageToken: Optional. The next_page_token returned from a previous List
132      request.
133    parent: List workflows in the given parent resource. Parent must be in the
134      form "projects/{projectId}/locations/{locationId}".
135  """
136
137  filter = _messages.StringField(1)
138  orderBy = _messages.StringField(2)
139  pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32)
140  pageToken = _messages.StringField(4)
141  parent = _messages.StringField(5, required=True)
142
143
144class ComposerflexProjectsLocationsWorkflowsRunsGetRequest(_messages.Message):
145  r"""A ComposerflexProjectsLocationsWorkflowsRunsGetRequest object.
146
147  Fields:
148    name: The resource name for the WorkflowRun in the form: "projects/{projec
149      tId}/locations/{locationId}/workflows/{workflowId}/runs/{runId}".
150  """
151
152  name = _messages.StringField(1, required=True)
153
154
155class ComposerflexProjectsLocationsWorkflowsRunsListRequest(_messages.Message):
156  r"""A ComposerflexProjectsLocationsWorkflowsRunsListRequest object.
157
158  Fields:
159    filter: Filter will remain internal until its future implementation.
160    orderBy: Optional. Specifies the ordering of results following syntax at
161      https://cloud.google.com/apis/design/design_patterns#sorting_order.
162      Order by will remain internal until its future implementation.
163    pageSize: The maximum number of workflows to return.
164    pageToken: Optional. The next_page_token returned from a previous List
165      request.
166    parent: The parent selector for the WorkflowRun. Supports parent in the
167      form:
168      "projects/{projectId}/locations/{locationId}/workflows/{workflowId}".
169  """
170
171  filter = _messages.StringField(1)
172  orderBy = _messages.StringField(2)
173  pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32)
174  pageToken = _messages.StringField(4)
175  parent = _messages.StringField(5, required=True)
176
177
178class Connection(_messages.Message):
179  r"""Represents an Airflow Connection. Usage of the fields within this
180  message is described in Airflow documentation:
181  https://airflow.apache.org/howto/connection/index.html#editing-a-connection-
182  with-the-ui
183
184  Enums:
185    TypeValueValuesEnum: The type of connection specified. This refers to the
186      service for which this connection is created.
187
188  Fields:
189    extra: The Airflow extra field for the connection.
190    host: The target host for the service.
191    id: The identifier for the connection.
192    login: The username if the service requires authentication.
193    password: Input only. Users can provide the password in plain-text. It
194      will be used to set the password in Airflow, but will not be stored for
195      retrieval on Google systems.
196    port: The port for the service.
197    schema: The Airflow schema field for the connection.
198    type: The type of connection specified. This refers to the service for
199      which this connection is created.
200  """
201
202  class TypeValueValuesEnum(_messages.Enum):
203    r"""The type of connection specified. This refers to the service for which
204    this connection is created.
205
206    Values:
207      TYPE_UNSPECIFIED: Unspecified connection type.
208      DOCKER: Docker connection type.
209      FILE: File connection type.
210      FTP: FTP connection type.
211      GOOGLE_CLOUD_PLATFORM: GCP connection type.
212      HDFS: HDFS connection type.
213      HTTP: HTTP connection type.
214      HIVE_CLI: Hive CLI connection type.
215      HIVE_METASTORE: Hive Metastore connection type.
216      HIVE_SERVER_2: Hive server connection type.
217      JDBC: JDBC connection type.
218      JENKINS: Jenkins connection type.
219      MYSQL: MySQL connection type.
220      POSTGRES: Postgres connection type.
221      ORACLE: Oracle connection type.
222      VERTICA: Vertica connection type.
223      PRESTO: Presto connection type.
224      S3: Amazon S3 connection type.
225      SAMBA: Samba connection type.
226      SQLITE: SQLite connection type.
227      SSH: SSH connection type.
228      CLOUDANT: Cloudant connection type.
229      MSSQL: MsSQL connection type.
230      MESOS_FRAMEWORK_ID: Mesos Framework connection type.
231      JIRA: Jira connection type.
232      REDIS: Redis connection type.
233      WASB: Wasb connection type.
234      DATABRICKS: Databricks connection type.
235      AWS: AWS connection type.
236      EMR: EMR connection type.
237      SNOWFLAKE: Snowflake connection type.
238      SEGMENT: Segment connection type.
239      AZURE_DATA_LAKE: Azure Data Lake connection type.
240      CASSANDRA: Cassandra connection type.
241    """
242    TYPE_UNSPECIFIED = 0
243    DOCKER = 1
244    FILE = 2
245    FTP = 3
246    GOOGLE_CLOUD_PLATFORM = 4
247    HDFS = 5
248    HTTP = 6
249    HIVE_CLI = 7
250    HIVE_METASTORE = 8
251    HIVE_SERVER_2 = 9
252    JDBC = 10
253    JENKINS = 11
254    MYSQL = 12
255    POSTGRES = 13
256    ORACLE = 14
257    VERTICA = 15
258    PRESTO = 16
259    S3 = 17
260    SAMBA = 18
261    SQLITE = 19
262    SSH = 20
263    CLOUDANT = 21
264    MSSQL = 22
265    MESOS_FRAMEWORK_ID = 23
266    JIRA = 24
267    REDIS = 25
268    WASB = 26
269    DATABRICKS = 27
270    AWS = 28
271    EMR = 29
272    SNOWFLAKE = 30
273    SEGMENT = 31
274    AZURE_DATA_LAKE = 32
275    CASSANDRA = 33
276
277  extra = _messages.StringField(1)
278  host = _messages.StringField(2)
279  id = _messages.StringField(3)
280  login = _messages.StringField(4)
281  password = _messages.StringField(5)
282  port = _messages.IntegerField(6, variant=_messages.Variant.INT32)
283  schema = _messages.StringField(7)
284  type = _messages.EnumField('TypeValueValuesEnum', 8)
285
286
287class Context(_messages.Message):
288  r"""A resource to hold configurations that are common across multiple
289  workflows.
290
291  Messages:
292    AirflowConfigOverridesValue: Optional. A user defined mapping of key value
293      pairs for Airflow Configurations.
294    AirflowVariablesValue: Optional. Key value pairs to make available to a
295      workflow. These are an application-level concept and are different from
296      environment variables, which are a process-level concept.
297    ConnectionsValue: Optional. A mapping from connection ID to Connections to
298      make available to the workflow. Each map entry's key should match the
299      `id` field of the // value.
300    EnvVariablesValue: Optional. Environment variables to provide to the
301      processes executing the workflow. Environment variable names must match
302      the regular expression "a-zA-Z_*". They cannot specify Apache Airflow
303      configuration overrides (they cannot match the regular expression
304      `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`)
305    LabelsValue: Optional. User-defined labels for this context. There can be
306      no more than 64 labels entries. Entries of the labels map are UTF8
307      strings that comply with the following restrictions: * Keys must conform
308      to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp:
309      [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally
310      constrained to be <= 128 bytes in size.
311    PoolsValue: Optional. A mapping from pool ID to Pools to make available to
312      the workflow. Each map entry's key should match the `id` field of the
313      value.
314
315  Fields:
316    airflowConfigOverrides: Optional. A user defined mapping of key value
317      pairs for Airflow Configurations.
318    airflowVariables: Optional. Key value pairs to make available to a
319      workflow. These are an application-level concept and are different from
320      environment variables, which are a process-level concept.
321    connections: Optional. A mapping from connection ID to Connections to make
322      available to the workflow. Each map entry's key should match the `id`
323      field of the // value.
324    createTime: Output only. The time the context was created.
325    envVariables: Optional. Environment variables to provide to the processes
326      executing the workflow. Environment variable names must match the
327      regular expression "a-zA-Z_*". They cannot specify Apache Airflow
328      configuration overrides (they cannot match the regular expression
329      `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`)
330    labels: Optional. User-defined labels for this context. There can be no
331      more than 64 labels entries. Entries of the labels map are UTF8 strings
332      that comply with the following restrictions: * Keys must conform to
333      regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp:
334      [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally
335      constrained to be <= 128 bytes in size.
336    name: The resource name of the context, in the form:
337      "projects/{projectId}/locations/{locationId}/contexts/{contextId}"
338    pools: Optional. A mapping from pool ID to Pools to make available to the
339      workflow. Each map entry's key should match the `id` field of the value.
340    updateTime: Output only. The time the context was last updated.
341  """
342
343  @encoding.MapUnrecognizedFields('additionalProperties')
344  class AirflowConfigOverridesValue(_messages.Message):
345    r"""Optional. A user defined mapping of key value pairs for Airflow
346    Configurations.
347
348    Messages:
349      AdditionalProperty: An additional property for a
350        AirflowConfigOverridesValue object.
351
352    Fields:
353      additionalProperties: Additional properties of type
354        AirflowConfigOverridesValue
355    """
356
357    class AdditionalProperty(_messages.Message):
358      r"""An additional property for a AirflowConfigOverridesValue object.
359
360      Fields:
361        key: Name of the additional property.
362        value: A string attribute.
363      """
364
365      key = _messages.StringField(1)
366      value = _messages.StringField(2)
367
368    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
369
370  @encoding.MapUnrecognizedFields('additionalProperties')
371  class AirflowVariablesValue(_messages.Message):
372    r"""Optional. Key value pairs to make available to a workflow. These are
373    an application-level concept and are different from environment variables,
374    which are a process-level concept.
375
376    Messages:
377      AdditionalProperty: An additional property for a AirflowVariablesValue
378        object.
379
380    Fields:
381      additionalProperties: Additional properties of type
382        AirflowVariablesValue
383    """
384
385    class AdditionalProperty(_messages.Message):
386      r"""An additional property for a AirflowVariablesValue object.
387
388      Fields:
389        key: Name of the additional property.
390        value: A string attribute.
391      """
392
393      key = _messages.StringField(1)
394      value = _messages.StringField(2)
395
396    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
397
398  @encoding.MapUnrecognizedFields('additionalProperties')
399  class ConnectionsValue(_messages.Message):
400    r"""Optional. A mapping from connection ID to Connections to make
401    available to the workflow. Each map entry's key should match the `id`
402    field of the // value.
403
404    Messages:
405      AdditionalProperty: An additional property for a ConnectionsValue
406        object.
407
408    Fields:
409      additionalProperties: Additional properties of type ConnectionsValue
410    """
411
412    class AdditionalProperty(_messages.Message):
413      r"""An additional property for a ConnectionsValue object.
414
415      Fields:
416        key: Name of the additional property.
417        value: A Connection attribute.
418      """
419
420      key = _messages.StringField(1)
421      value = _messages.MessageField('Connection', 2)
422
423    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
424
425  @encoding.MapUnrecognizedFields('additionalProperties')
426  class EnvVariablesValue(_messages.Message):
427    r"""Optional. Environment variables to provide to the processes executing
428    the workflow. Environment variable names must match the regular expression
429    "a-zA-Z_*". They cannot specify Apache Airflow configuration overrides
430    (they cannot match the regular expression
431    `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`)
432
433    Messages:
434      AdditionalProperty: An additional property for a EnvVariablesValue
435        object.
436
437    Fields:
438      additionalProperties: Additional properties of type EnvVariablesValue
439    """
440
441    class AdditionalProperty(_messages.Message):
442      r"""An additional property for a EnvVariablesValue object.
443
444      Fields:
445        key: Name of the additional property.
446        value: A string attribute.
447      """
448
449      key = _messages.StringField(1)
450      value = _messages.StringField(2)
451
452    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
453
454  @encoding.MapUnrecognizedFields('additionalProperties')
455  class LabelsValue(_messages.Message):
456    r"""Optional. User-defined labels for this context. There can be no more
457    than 64 labels entries. Entries of the labels map are UTF8 strings that
458    comply with the following restrictions: * Keys must conform to regexp:
459    \p{Ll}\p{Lo}{0,62} * Values must conform to regexp:
460    [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally
461    constrained to be <= 128 bytes in size.
462
463    Messages:
464      AdditionalProperty: An additional property for a LabelsValue object.
465
466    Fields:
467      additionalProperties: Additional properties of type LabelsValue
468    """
469
470    class AdditionalProperty(_messages.Message):
471      r"""An additional property for a LabelsValue object.
472
473      Fields:
474        key: Name of the additional property.
475        value: A string attribute.
476      """
477
478      key = _messages.StringField(1)
479      value = _messages.StringField(2)
480
481    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
482
483  @encoding.MapUnrecognizedFields('additionalProperties')
484  class PoolsValue(_messages.Message):
485    r"""Optional. A mapping from pool ID to Pools to make available to the
486    workflow. Each map entry's key should match the `id` field of the value.
487
488    Messages:
489      AdditionalProperty: An additional property for a PoolsValue object.
490
491    Fields:
492      additionalProperties: Additional properties of type PoolsValue
493    """
494
495    class AdditionalProperty(_messages.Message):
496      r"""An additional property for a PoolsValue object.
497
498      Fields:
499        key: Name of the additional property.
500        value: A Pool attribute.
501      """
502
503      key = _messages.StringField(1)
504      value = _messages.MessageField('Pool', 2)
505
506    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
507
508  airflowConfigOverrides = _messages.MessageField('AirflowConfigOverridesValue', 1)
509  airflowVariables = _messages.MessageField('AirflowVariablesValue', 2)
510  connections = _messages.MessageField('ConnectionsValue', 3)
511  createTime = _messages.StringField(4)
512  envVariables = _messages.MessageField('EnvVariablesValue', 5)
513  labels = _messages.MessageField('LabelsValue', 6)
514  name = _messages.StringField(7)
515  pools = _messages.MessageField('PoolsValue', 8)
516  updateTime = _messages.StringField(9)
517
518
519class ListContextsResponse(_messages.Message):
520  r"""Response for a ListContextsRequest.
521
522  Fields:
523    contexts: The list of contexts returned.
524    nextPageToken: The page token used to query for the next page if one
525      exists.
526  """
527
528  contexts = _messages.MessageField('Context', 1, repeated=True)
529  nextPageToken = _messages.StringField(2)
530
531
532class ListWorkflowRunsResponse(_messages.Message):
533  r"""Response for ListWorkflowRunsRequest.
534
535  Fields:
536    nextPageToken: The page token used to query for the next page if one
537      exists.
538    workflowRuns: The returned list of WorkflowRuns.
539  """
540
541  nextPageToken = _messages.StringField(1)
542  workflowRuns = _messages.MessageField('WorkflowRun', 2, repeated=True)
543
544
545class ListWorkflowsResponse(_messages.Message):
546  r"""Response to ListWorkflowsRequest.
547
548  Fields:
549    nextPageToken: The page token used to query for the next page if one
550      exists.
551    workflows: The list of workflows returned.
552  """
553
554  nextPageToken = _messages.StringField(1)
555  workflows = _messages.MessageField('Workflow', 2, repeated=True)
556
557
558class Operation(_messages.Message):
559  r"""This resource represents a long-running operation that is the result of
560  a network API call.
561
562  Messages:
563    MetadataValue: Service-specific metadata associated with the operation. It
564      typically contains progress information and common metadata such as
565      create time. Some services might not provide such metadata. Any method
566      that returns a long-running operation should document the metadata type,
567      if any.
568    ResponseValue: The normal response of the operation in case of success. If
569      the original method returns no data on success, such as `Delete`, the
570      response is `google.protobuf.Empty`. If the original method is standard
571      `Get`/`Create`/`Update`, the response should be the resource. For other
572      methods, the response should have the type `XxxResponse`, where `Xxx` is
573      the original method name. For example, if the original method name is
574      `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
575
576  Fields:
577    done: If the value is `false`, it means the operation is still in
578      progress. If `true`, the operation is completed, and either `error` or
579      `response` is available.
580    error: The error result of the operation in case of failure or
581      cancellation.
582    metadata: Service-specific metadata associated with the operation. It
583      typically contains progress information and common metadata such as
584      create time. Some services might not provide such metadata. Any method
585      that returns a long-running operation should document the metadata type,
586      if any.
587    name: The server-assigned name, which is only unique within the same
588      service that originally returns it. If you use the default HTTP mapping,
589      the `name` should be a resource name ending with
590      `operations/{unique_id}`.
591    response: The normal response of the operation in case of success. If the
592      original method returns no data on success, such as `Delete`, the
593      response is `google.protobuf.Empty`. If the original method is standard
594      `Get`/`Create`/`Update`, the response should be the resource. For other
595      methods, the response should have the type `XxxResponse`, where `Xxx` is
596      the original method name. For example, if the original method name is
597      `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
598  """
599
600  @encoding.MapUnrecognizedFields('additionalProperties')
601  class MetadataValue(_messages.Message):
602    r"""Service-specific metadata associated with the operation. It typically
603    contains progress information and common metadata such as create time.
604    Some services might not provide such metadata. Any method that returns a
605    long-running operation should document the metadata type, if any.
606
607    Messages:
608      AdditionalProperty: An additional property for a MetadataValue object.
609
610    Fields:
611      additionalProperties: Properties of the object. Contains field @type
612        with type URL.
613    """
614
615    class AdditionalProperty(_messages.Message):
616      r"""An additional property for a MetadataValue object.
617
618      Fields:
619        key: Name of the additional property.
620        value: A extra_types.JsonValue attribute.
621      """
622
623      key = _messages.StringField(1)
624      value = _messages.MessageField('extra_types.JsonValue', 2)
625
626    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
627
628  @encoding.MapUnrecognizedFields('additionalProperties')
629  class ResponseValue(_messages.Message):
630    r"""The normal response of the operation in case of success. If the
631    original method returns no data on success, such as `Delete`, the response
632    is `google.protobuf.Empty`. If the original method is standard
633    `Get`/`Create`/`Update`, the response should be the resource. For other
634    methods, the response should have the type `XxxResponse`, where `Xxx` is
635    the original method name. For example, if the original method name is
636    `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
637
638    Messages:
639      AdditionalProperty: An additional property for a ResponseValue object.
640
641    Fields:
642      additionalProperties: Properties of the object. Contains field @type
643        with type URL.
644    """
645
646    class AdditionalProperty(_messages.Message):
647      r"""An additional property for a ResponseValue object.
648
649      Fields:
650        key: Name of the additional property.
651        value: A extra_types.JsonValue attribute.
652      """
653
654      key = _messages.StringField(1)
655      value = _messages.MessageField('extra_types.JsonValue', 2)
656
657    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
658
659  done = _messages.BooleanField(1)
660  error = _messages.MessageField('Status', 2)
661  metadata = _messages.MessageField('MetadataValue', 3)
662  name = _messages.StringField(4)
663  response = _messages.MessageField('ResponseValue', 5)
664
665
666class Pool(_messages.Message):
667  r"""Represents an Airflow Pool.
668
669  Fields:
670    id: The identifier for the pool.
671    slots: The number of slots available for the pool.
672  """
673
674  id = _messages.StringField(1)
675  slots = _messages.IntegerField(2, variant=_messages.Variant.INT32)
676
677
678class StandardQueryParameters(_messages.Message):
679  r"""Query parameters accepted by all methods.
680
681  Enums:
682    FXgafvValueValuesEnum: V1 error format.
683    AltValueValuesEnum: Data format for response.
684
685  Fields:
686    f__xgafv: V1 error format.
687    access_token: OAuth access token.
688    alt: Data format for response.
689    callback: JSONP
690    fields: Selector specifying which fields to include in a partial response.
691    key: API key. Your API key identifies your project and provides you with
692      API access, quota, and reports. Required unless you provide an OAuth 2.0
693      token.
694    oauth_token: OAuth 2.0 token for the current user.
695    prettyPrint: Returns response with indentations and line breaks.
696    quotaUser: Available to use for quota purposes for server-side
697      applications. Can be any arbitrary string assigned to a user, but should
698      not exceed 40 characters.
699    trace: A tracing token of the form "token:<tokenid>" to include in api
700      requests.
701    uploadType: Legacy upload protocol for media (e.g. "media", "multipart").
702    upload_protocol: Upload protocol for media (e.g. "raw", "multipart").
703  """
704
705  class AltValueValuesEnum(_messages.Enum):
706    r"""Data format for response.
707
708    Values:
709      json: Responses with Content-Type of application/json
710      media: Media download with context-dependent Content-Type
711      proto: Responses with Content-Type of application/x-protobuf
712    """
713    json = 0
714    media = 1
715    proto = 2
716
717  class FXgafvValueValuesEnum(_messages.Enum):
718    r"""V1 error format.
719
720    Values:
721      _1: v1 error format
722      _2: v2 error format
723    """
724    _1 = 0
725    _2 = 1
726
727  f__xgafv = _messages.EnumField('FXgafvValueValuesEnum', 1)
728  access_token = _messages.StringField(2)
729  alt = _messages.EnumField('AltValueValuesEnum', 3, default='json')
730  callback = _messages.StringField(4)
731  fields = _messages.StringField(5)
732  key = _messages.StringField(6)
733  oauth_token = _messages.StringField(7)
734  prettyPrint = _messages.BooleanField(8, default=True)
735  quotaUser = _messages.StringField(9)
736  trace = _messages.StringField(10)
737  uploadType = _messages.StringField(11)
738  upload_protocol = _messages.StringField(12)
739
740
741class Status(_messages.Message):
742  r"""The `Status` type defines a logical error model that is suitable for
743  different programming environments, including REST APIs and RPC APIs. It is
744  used by [gRPC](https://github.com/grpc). Each `Status` message contains
745  three pieces of data: error code, error message, and error details. You can
746  find out more about this error model and how to work with it in the [API
747  Design Guide](https://cloud.google.com/apis/design/errors).
748
749  Messages:
750    DetailsValueListEntry: A DetailsValueListEntry object.
751
752  Fields:
753    code: The status code, which should be an enum value of google.rpc.Code.
754    details: A list of messages that carry the error details. There is a
755      common set of message types for APIs to use.
756    message: A developer-facing error message, which should be in English. Any
757      user-facing error message should be localized and sent in the
758      google.rpc.Status.details field, or localized by the client.
759  """
760
761  @encoding.MapUnrecognizedFields('additionalProperties')
762  class DetailsValueListEntry(_messages.Message):
763    r"""A DetailsValueListEntry object.
764
765    Messages:
766      AdditionalProperty: An additional property for a DetailsValueListEntry
767        object.
768
769    Fields:
770      additionalProperties: Properties of the object. Contains field @type
771        with type URL.
772    """
773
774    class AdditionalProperty(_messages.Message):
775      r"""An additional property for a DetailsValueListEntry object.
776
777      Fields:
778        key: Name of the additional property.
779        value: A extra_types.JsonValue attribute.
780      """
781
782      key = _messages.StringField(1)
783      value = _messages.MessageField('extra_types.JsonValue', 2)
784
785    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
786
787  code = _messages.IntegerField(1, variant=_messages.Variant.INT32)
788  details = _messages.MessageField('DetailsValueListEntry', 2, repeated=True)
789  message = _messages.StringField(3)
790
791
792class Workflow(_messages.Message):
793  r"""A Composer workflow resource.
794
795  Enums:
796    StateValueValuesEnum: Output only. The current state of the workflow.
797
798  Messages:
799    LabelsValue: Optional. User-defined labels for this workflow. Workflow
800      runs instantiated from this workflow will inherit these labels. The
801      labels map can contain no more than 64 entries. Entries of the labels
802      map are UTF8 strings that comply with the following restrictions: * Keys
803      must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to
804      regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are
805      additionally constrained to be <= 128 bytes in size.
806
807  Fields:
808    airflowDag: A representation of the workflow as Python source code
809      defining an Airflow DAG.
810    airflowVersion: The version of Airflow at which to run the DAG. For
811      example, "1.10.0".
812    composerVersion: Output only. The version of Composer that created this
813      workflow.
814    context: The context to use when executing this workflow. The context
815      resides in the same project and location as this workflow. The context
816      must be specified as the full resource name. The format is:
817      projects/{projectId}/locations/{locationId}/contexts/{contextId}
818    createTime: Output only. The time at which this workflow was created.
819    labels: Optional. User-defined labels for this workflow. Workflow runs
820      instantiated from this workflow will inherit these labels. The labels
821      map can contain no more than 64 entries. Entries of the labels map are
822      UTF8 strings that comply with the following restrictions: * Keys must
823      conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp:
824      [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally
825      constrained to be <= 128 bytes in size.
826    name: The resource name of the workflow, in the form:
827      "projects/{projectId}/locations/{locationId}/workflows/{workflowId}"
828    pythonVersion: The major version of Python used to run Apache Airflow
829      processes. Can be set to '2' or '3'. If not specified, the default is
830      '2'.
831    state: Output only. The current state of the workflow.
832    updateTime: Output only. The time at which this workflow was last updated.
833  """
834
835  class StateValueValuesEnum(_messages.Enum):
836    r"""Output only. The current state of the workflow.
837
838    Values:
839      STATE_UNSPECIFIED: The state of the workflow is unknown.
840      CREATING: The workflow is being created and cannot execute.
841      ACTIVE: The workflow is available for execution.
842      ERROR: The workflow is in an error state and cannot execute.
843    """
844    STATE_UNSPECIFIED = 0
845    CREATING = 1
846    ACTIVE = 2
847    ERROR = 3
848
849  @encoding.MapUnrecognizedFields('additionalProperties')
850  class LabelsValue(_messages.Message):
851    r"""Optional. User-defined labels for this workflow. Workflow runs
852    instantiated from this workflow will inherit these labels. The labels map
853    can contain no more than 64 entries. Entries of the labels map are UTF8
854    strings that comply with the following restrictions: * Keys must conform
855    to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp:
856    [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally
857    constrained to be <= 128 bytes in size.
858
859    Messages:
860      AdditionalProperty: An additional property for a LabelsValue object.
861
862    Fields:
863      additionalProperties: Additional properties of type LabelsValue
864    """
865
866    class AdditionalProperty(_messages.Message):
867      r"""An additional property for a LabelsValue object.
868
869      Fields:
870        key: Name of the additional property.
871        value: A string attribute.
872      """
873
874      key = _messages.StringField(1)
875      value = _messages.StringField(2)
876
877    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
878
879  airflowDag = _messages.MessageField('AirflowDag', 1)
880  airflowVersion = _messages.StringField(2)
881  composerVersion = _messages.StringField(3)
882  context = _messages.StringField(4)
883  createTime = _messages.StringField(5)
884  labels = _messages.MessageField('LabelsValue', 6)
885  name = _messages.StringField(7)
886  pythonVersion = _messages.StringField(8)
887  state = _messages.EnumField('StateValueValuesEnum', 9)
888  updateTime = _messages.StringField(10)
889
890
891class WorkflowRun(_messages.Message):
892  r"""WorkflowRun represents a single execution of a Workflow.
893
894  Enums:
895    StateValueValuesEnum: Output only. The latest known state of the workflow
896      run.
897
898  Messages:
899    LabelsValue: Optional. User-defined labels for this workflow run. The
900      initial label entries for a workflow run are inherited from the workflow
901      from which it was instantiated. There can be no more than 64 labels
902      entries. Entries of the labels map are UTF8 strings that comply with the
903      following restrictions: * Keys must conform to regexp:
904      \p{Ll}\p{Lo}{0,62} * Values must conform to regexp:
905      [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally
906      constrained to be <= 128 bytes in size.
907
908  Fields:
909    endTime: Output only. The end time of the workflow run.
910    intervalStartTime: Output only. The start of the time interval
911      corresponding to this workflow run. Only set for SCHEDULED runs. This
912      value is analagous to the Apache Airflow notion of `execution_date`; it
913      refers to the left boundary of the scheduling interval.
914    labels: Optional. User-defined labels for this workflow run. The initial
915      label entries for a workflow run are inherited from the workflow from
916      which it was instantiated. There can be no more than 64 labels entries.
917      Entries of the labels map are UTF8 strings that comply with the
918      following restrictions: * Keys must conform to regexp:
919      \p{Ll}\p{Lo}{0,62} * Values must conform to regexp:
920      [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally
921      constrained to be <= 128 bytes in size.
922    name: Output only. The resource name of the workflow run, in the form: "pr
923      ojects/{projectId}/locations/{locationId}/workflows/{workflowId}/runs/{r
924      unId}"
925    startTime: Output only. The start time of the workflow run.
926    state: Output only. The latest known state of the workflow run.
927  """
928
929  class StateValueValuesEnum(_messages.Enum):
930    r"""Output only. The latest known state of the workflow run.
931
932    Values:
933      STATE_UNSPECIFIED: The state of the WorkflowRun is unknown.
934      RUNNING: The WorkflowRun is currently running.
935      SUCCESS: The WorkflowRun succeeded.
936      FAILED: The WorkflowRun failed.
937    """
938    STATE_UNSPECIFIED = 0
939    RUNNING = 1
940    SUCCESS = 2
941    FAILED = 3
942
943  @encoding.MapUnrecognizedFields('additionalProperties')
944  class LabelsValue(_messages.Message):
945    r"""Optional. User-defined labels for this workflow run. The initial label
946    entries for a workflow run are inherited from the workflow from which it
947    was instantiated. There can be no more than 64 labels entries. Entries of
948    the labels map are UTF8 strings that comply with the following
949    restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values
950    must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values
951    are additionally constrained to be <= 128 bytes in size.
952
953    Messages:
954      AdditionalProperty: An additional property for a LabelsValue object.
955
956    Fields:
957      additionalProperties: Additional properties of type LabelsValue
958    """
959
960    class AdditionalProperty(_messages.Message):
961      r"""An additional property for a LabelsValue object.
962
963      Fields:
964        key: Name of the additional property.
965        value: A string attribute.
966      """
967
968      key = _messages.StringField(1)
969      value = _messages.StringField(2)
970
971    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
972
973  endTime = _messages.StringField(1)
974  intervalStartTime = _messages.StringField(2)
975  labels = _messages.MessageField('LabelsValue', 3)
976  name = _messages.StringField(4)
977  startTime = _messages.StringField(5)
978  state = _messages.EnumField('StateValueValuesEnum', 6)
979
980
981encoding.AddCustomJsonFieldMapping(
982    StandardQueryParameters, 'f__xgafv', '$.xgafv')
983encoding.AddCustomJsonEnumMapping(
984    StandardQueryParameters.FXgafvValueValuesEnum, '_1', '1')
985encoding.AddCustomJsonEnumMapping(
986    StandardQueryParameters.FXgafvValueValuesEnum, '_2', '2')
987