Close httplib2 connections.
create(parent, body=None, workflowConfigId=None, x__xgafv=None)
Creates a new WorkflowConfig in a given Repository.
Deletes a single WorkflowConfig.
Fetches a single WorkflowConfig.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists WorkflowConfigs in a given Repository.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a single WorkflowConfig. *Note:* This method does not fully implement AIP/134. In particular: 1. The wildcard entry (***) is treated as a bad request 2. When the *field_mask* is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields
close()
Close httplib2 connections.
create(parent, body=None, workflowConfigId=None, x__xgafv=None)
Creates a new WorkflowConfig in a given Repository.
Args:
parent: string, Required. The repository in which to create the workflow config. Must be in the format `projects/*/locations/*/repositories/*`. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Dataform workflow configuration.
"createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
"cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
"invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. 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.
},
"name": "A String", # Identifier. The workflow config's name.
"recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
{ # A record of an attempt to create a workflow invocation for this workflow config.
"errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"executionTime": "A String", # The timestamp of this execution attempt.
"workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
},
],
"releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
"updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
}
workflowConfigId: string, Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a Dataform workflow configuration.
"createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
"cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
"invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. 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.
},
"name": "A String", # Identifier. The workflow config's name.
"recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
{ # A record of an attempt to create a workflow invocation for this workflow config.
"errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"executionTime": "A String", # The timestamp of this execution attempt.
"workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
},
],
"releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
"updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
}
delete(name, x__xgafv=None)
Deletes a single WorkflowConfig.
Args:
name: string, Required. The workflow config'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 WorkflowConfig.
Args:
name: string, Required. The workflow config'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 Dataform workflow configuration.
"createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
"cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
"invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. 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.
},
"name": "A String", # Identifier. The workflow config's name.
"recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
{ # A record of an attempt to create a workflow invocation for this workflow config.
"errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"executionTime": "A String", # The timestamp of this execution attempt.
"workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
},
],
"releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
"updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists WorkflowConfigs in a given Repository.
Args:
parent: string, Required. The repository in which to list workflow configs. Must be in the format `projects/*/locations/*/repositories/*`. (required)
pageSize: integer, Optional. Maximum number of workflow configs 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 `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, 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:
{ # `ListWorkflowConfigs` 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",
],
"workflowConfigs": [ # List of workflow configs.
{ # Represents a Dataform workflow configuration.
"createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
"cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
"invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. 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.
},
"name": "A String", # Identifier. The workflow config's name.
"recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
{ # A record of an attempt to create a workflow invocation for this workflow config.
"errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"executionTime": "A String", # The timestamp of this execution attempt.
"workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
},
],
"releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
"updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
},
],
}
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.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a single WorkflowConfig. *Note:* This method does not fully implement AIP/134. In particular: 1. The wildcard entry (***) is treated as a bad request 2. When the *field_mask* is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields
Args:
name: string, Identifier. The workflow config's name. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Dataform workflow configuration.
"createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
"cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
"invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. 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.
},
"name": "A String", # Identifier. The workflow config's name.
"recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
{ # A record of an attempt to create a workflow invocation for this workflow config.
"errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"executionTime": "A String", # The timestamp of this execution attempt.
"workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
},
],
"releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
"updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
}
updateMask: string, Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a Dataform workflow configuration.
"createTime": "A String", # Output only. The timestamp of when the WorkflowConfig was created.
"cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
"invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. 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.
},
"name": "A String", # Identifier. The workflow config's name.
"recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
{ # A record of an attempt to create a workflow invocation for this workflow config.
"errorStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"executionTime": "A String", # The timestamp of this execution attempt.
"workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
},
],
"releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
"timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
"updateTime": "A String", # Output only. The timestamp of when the WorkflowConfig was last updated.
}