Dataform API . projects . locations . repositories . workflowInvocations

cancel(name, body=None, x__xgafv=None)

Requests cancellation of a running WorkflowInvocation.

Args:
  name: string, Required. The workflow invocation resource's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # `CancelWorkflowInvocation` request message.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a new WorkflowInvocation in a given Repository.

Args:
  parent: string, Required. The repository in which to create the workflow invocation. Must be in the format `projects/*/locations/*/repositories/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a single invocation of a compilation result.
  "compilationResult": "A String", # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
    "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted.
  },
  "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
    "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
    "includedTags": [ # Optional. The set of tags to include.
      "A String",
    ],
    "includedTargets": [ # Optional. The set of action identifiers to include.
      { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
        "database": "A String", # The action's database (Google Cloud project ID) .
        "name": "A String", # The action's name, within `database` and `schema`.
        "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
      },
    ],
    "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
    "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
    "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
  },
  "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation's timing details.
    "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
    "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
  },
  "name": "A String", # Output only. The workflow invocation's name.
  "resolvedCompilationResult": "A String", # Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
  "state": "A String", # Output only. This workflow invocation's current state.
  "workflowConfig": "A String", # Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a single invocation of a compilation result.
  "compilationResult": "A String", # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
    "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted.
  },
  "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
    "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
    "includedTags": [ # Optional. The set of tags to include.
      "A String",
    ],
    "includedTargets": [ # Optional. The set of action identifiers to include.
      { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
        "database": "A String", # The action's database (Google Cloud project ID) .
        "name": "A String", # The action's name, within `database` and `schema`.
        "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
      },
    ],
    "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
    "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
    "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
  },
  "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation's timing details.
    "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
    "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
  },
  "name": "A String", # Output only. The workflow invocation's name.
  "resolvedCompilationResult": "A String", # Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
  "state": "A String", # Output only. This workflow invocation's current state.
  "workflowConfig": "A String", # Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
}

delete(name, x__xgafv=None)

Deletes a single WorkflowInvocation.

Args:
  name: string, Required. The workflow invocation resource's name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Fetches a single WorkflowInvocation.

Args:
  name: string, Required. The workflow invocation resource's name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a single invocation of a compilation result.
  "compilationResult": "A String", # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
    "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted.
  },
  "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
    "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
    "includedTags": [ # Optional. The set of tags to include.
      "A String",
    ],
    "includedTargets": [ # Optional. The set of action identifiers to include.
      { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
        "database": "A String", # The action's database (Google Cloud project ID) .
        "name": "A String", # The action's name, within `database` and `schema`.
        "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
      },
    ],
    "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
    "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
    "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
  },
  "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation's timing details.
    "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
    "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
  },
  "name": "A String", # Output only. The workflow invocation's name.
  "resolvedCompilationResult": "A String", # Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
  "state": "A String", # Output only. This workflow invocation's current state.
  "workflowConfig": "A String", # Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists WorkflowInvocations in a given Repository.

Args:
  parent: string, Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/*/locations/*/repositories/*`. (required)
  filter: string, Optional. Filter for the returned list.
  orderBy: string, Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
  pageSize: integer, Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  pageToken: string, Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations`, with the exception of `page_size`, must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `ListWorkflowInvocations` response message.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "unreachable": [ # Locations which could not be reached.
    "A String",
  ],
  "workflowInvocations": [ # List of workflow invocations.
    { # Represents a single invocation of a compilation result.
      "compilationResult": "A String", # Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
      "dataEncryptionState": { # Describes encryption state of a resource. # Output only. Only set if the repository has a KMS Key.
        "kmsKeyVersionName": "A String", # The KMS key version name with which data of a resource is encrypted.
      },
      "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
        "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
        "includedTags": [ # Optional. The set of tags to include.
          "A String",
        ],
        "includedTargets": [ # Optional. The set of action identifiers to include.
          { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
            "database": "A String", # The action's database (Google Cloud project ID) .
            "name": "A String", # The action's name, within `database` and `schema`.
            "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
          },
        ],
        "serviceAccount": "A String", # Optional. The service account to run workflow invocations under.
        "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
        "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
      },
      "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation's timing details.
        "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
        "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
      },
      "name": "A String", # Output only. The workflow invocation's name.
      "resolvedCompilationResult": "A String", # Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
      "state": "A String", # Output only. This workflow invocation's current state.
      "workflowConfig": "A String", # Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

query(name, pageSize=None, pageToken=None, x__xgafv=None)

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Args:
  name: string, Required. The workflow invocation's name. (required)
  pageSize: integer, Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  pageToken: string, Optional. Page token received from a previous `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions`, with the exception of `page_size`, must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `QueryWorkflowInvocationActions` response message.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "workflowInvocationActions": [ # List of workflow invocation actions.
    { # Represents a single action in a workflow invocation.
      "bigqueryAction": { # Represents a workflow action that will run against BigQuery. # Output only. The workflow action's bigquery action details.
        "jobId": "A String", # Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run.
        "sqlScript": "A String", # Output only. The generated BigQuery SQL script that will be executed.
      },
      "canonicalTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.
        "database": "A String", # The action's database (Google Cloud project ID) .
        "name": "A String", # The action's name, within `database` and `schema`.
        "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
      },
      "failureReason": "A String", # Output only. If and only if action's state is FAILED a failure reason is set.
      "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This action's timing details. `start_time` will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. `end_time` will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state.
        "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
        "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
      },
      "notebookAction": { # Represents a workflow action that will run against a Notebook runtime. # Output only. The workflow action's notebook action details.
        "contents": "A String", # Output only. The code contents of a Notebook to be run.
        "jobId": "A String", # Output only. The ID of the Vertex job that executed the notebook in contents and also the ID used for the outputs created in GCS buckets. Only set once the job has started to run.
      },
      "state": "A String", # Output only. This action's current state.
      "target": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. This action's identifier. Unique within the workflow invocation.
        "database": "A String", # The action's database (Google Cloud project ID) .
        "name": "A String", # The action's name, within `database` and `schema`.
        "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
      },
    },
  ],
}

query_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.