Namespace Google.Apis.Dataflow.v1b3
Classes
DataflowBaseServiceRequest<TResponse>
A base abstract class for Dataflow requests.
DataflowService
The Dataflow Service.
DataflowService.Scope
Available OAuth 2.0 scopes for use with the Dataflow API.
DataflowService.ScopeConstants
Available OAuth 2.0 scope constants for use with the Dataflow API.
ProjectsResource
The "projects" collection of methods.
ProjectsResource.DeleteSnapshotsRequest
Deletes a snapshot.
ProjectsResource.JobsResource
The "jobs" collection of methods.
ProjectsResource.JobsResource.AggregatedRequest
List the jobs of a project across all regions. Note: This method doesn't support filtering the list
of jobs by name. # IAM Permissions Requires the dataflow.jobs.list permission on the project.
ProjectsResource.JobsResource.CreateRequest
Creates a Dataflow job. To create a job, we recommend using projects.locations.jobs.create with a
[regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using
projects.jobs.create is not recommended, as your job will always start in us-central1. Do not enter
confidential information when you supply string values using the API. # IAM Permissions 1. Requires the
dataflow.jobs.create permission on the project. 2. resourcemanager.projects.get (Specifically
required for regional endpoints to resolve regional resource metadata)
ProjectsResource.JobsResource.DebugResource
The "debug" collection of methods.
ProjectsResource.JobsResource.DebugResource.GetConfigRequest
Get encoded debug configuration for component. Not cacheable.
ProjectsResource.JobsResource.DebugResource.SendCaptureRequest
Send encoded debug capture data for component.
ProjectsResource.JobsResource.GetMetricsRequest
Request the job status. To request the status of a job, we recommend using
projects.locations.jobs.getMetrics with a [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.getMetrics
is not recommended, as you can only request the status of jobs that are running in us-central1. # IAM
Permissions Requires the dataflow.metrics.get permission on the job.
ProjectsResource.JobsResource.GetRequest
Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using
projects.locations.jobs.get with a [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.get is not
recommended, as you can only get the state of jobs that are running in us-central1. # IAM Permissions
Requires the dataflow.jobs.get permission on the job.
ProjectsResource.JobsResource.ListRequest
List the jobs of a project. To list the jobs of a project in a region, we recommend using
projects.locations.jobs.list with a [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all
regions, use projects.jobs.aggregated. Using projects.jobs.list is not recommended, because you can
only get the list of jobs that are running in us-central1. projects.locations.jobs.list and
projects.jobs.list support filtering the list of jobs by name. Filtering by name isn't supported by
projects.jobs.aggregated. # IAM Permissions Requires the dataflow.jobs.list permission on the
project.
ProjectsResource.JobsResource.MessagesResource
The "messages" collection of methods.
ProjectsResource.JobsResource.MessagesResource.ListRequest
Request the job status. To request the status of a job, we recommend using
projects.locations.jobs.messages.list with a [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using
projects.jobs.messages.list is not recommended, as you can only request the status of jobs that
are running in us-central1. # IAM Permissions Requires the dataflow.messages.list permission on
the job.
ProjectsResource.JobsResource.SnapshotRequest
Snapshot the state of a streaming job. # IAM Permissions Requires the dataflow.jobs.snapshot
permission on the job.
ProjectsResource.JobsResource.UpdateRequest
Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we
recommend using projects.locations.jobs.update with a [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.update is
not recommended, as you can only update the state of jobs that are running in us-central1. # IAM
Permissions 1. Requires the dataflow.jobs.cancel permission to cancel a job. 2. Requires the
dataflow.jobs.updateContents permission to update runtime parameters.
ProjectsResource.JobsResource.WorkItemsResource
The "workItems" collection of methods.
ProjectsResource.JobsResource.WorkItemsResource.LeaseRequest
Leases a dataflow WorkItem to run.
ProjectsResource.JobsResource.WorkItemsResource.ReportStatusRequest
Reports the status of dataflow WorkItems leased by a worker.
ProjectsResource.LocationsResource
The "locations" collection of methods.
ProjectsResource.LocationsResource.FlexTemplatesResource
The "flexTemplates" collection of methods.
ProjectsResource.LocationsResource.FlexTemplatesResource.LaunchRequest
Launch a job with a FlexTemplate. # IAM Permissions Requires the following IAM permission(s) on the
resource: - dataflow.jobs.create - resourcemanager.projects.get - iam.serviceAccounts.actAs -
storage.buckets.get - storage.buckets.create (Required if the default staging bucket must be
created)
ProjectsResource.LocationsResource.JobsResource
The "jobs" collection of methods.
ProjectsResource.LocationsResource.JobsResource.CreateRequest
Creates a Dataflow job. To create a job, we recommend using projects.locations.jobs.create with a
[regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using
projects.jobs.create is not recommended, as your job will always start in us-central1. Do not
enter confidential information when you supply string values using the API. # IAM Permissions 1.
Requires the dataflow.jobs.create permission on the project. 2. resourcemanager.projects.get
(Specifically required for regional endpoints to resolve regional resource metadata)
ProjectsResource.LocationsResource.JobsResource.DebugResource
The "debug" collection of methods.
ProjectsResource.LocationsResource.JobsResource.DebugResource.GetConfigRequest
Get encoded debug configuration for component. Not cacheable.
ProjectsResource.LocationsResource.JobsResource.DebugResource.GetWorkerStacktracesRequest
Get worker stacktraces from debug capture.
ProjectsResource.LocationsResource.JobsResource.DebugResource.SendCaptureRequest
Send encoded debug capture data for component.
ProjectsResource.LocationsResource.JobsResource.GetExecutionDetailsRequest
Request detailed information about the execution status of the job. EXPERIMENTAL. This API is
subject to change or removal without notice. # IAM Permissions Requires the dataflow.metrics.get
permission on the job.
ProjectsResource.LocationsResource.JobsResource.GetMetricsRequest
Request the job status. To request the status of a job, we recommend using
projects.locations.jobs.getMetrics with a [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using
projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are
running in us-central1. # IAM Permissions Requires the dataflow.metrics.get permission on the
job.
ProjectsResource.LocationsResource.JobsResource.GetRequest
Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using
projects.locations.jobs.get with a [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.get is
not recommended, as you can only get the state of jobs that are running in us-central1. # IAM
Permissions Requires the dataflow.jobs.get permission on the job.
ProjectsResource.LocationsResource.JobsResource.ListRequest
List the jobs of a project. To list the jobs of a project in a region, we recommend using
projects.locations.jobs.list with a [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across
all regions, use projects.jobs.aggregated. Using projects.jobs.list is not recommended, because
you can only get the list of jobs that are running in us-central1. projects.locations.jobs.list
and projects.jobs.list support filtering the list of jobs by name. Filtering by name isn't
supported by projects.jobs.aggregated. # IAM Permissions Requires the dataflow.jobs.list
permission on the project.
ProjectsResource.LocationsResource.JobsResource.MessagesResource
The "messages" collection of methods.
ProjectsResource.LocationsResource.JobsResource.MessagesResource.ListRequest
Request the job status. To request the status of a job, we recommend using
projects.locations.jobs.messages.list with a [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using
projects.jobs.messages.list is not recommended, as you can only request the status of jobs
that are running in us-central1. # IAM Permissions Requires the dataflow.messages.list
permission on the job.
ProjectsResource.LocationsResource.JobsResource.SnapshotRequest
Snapshot the state of a streaming job. # IAM Permissions Requires the dataflow.jobs.snapshot
permission on the job.
ProjectsResource.LocationsResource.JobsResource.SnapshotsResource
The "snapshots" collection of methods.
ProjectsResource.LocationsResource.JobsResource.SnapshotsResource.ListRequest
Lists snapshots.
ProjectsResource.LocationsResource.JobsResource.StagesResource
The "stages" collection of methods.
ProjectsResource.LocationsResource.JobsResource.StagesResource.GetExecutionDetailsRequest
Request detailed information about the execution status of a stage of the job. EXPERIMENTAL.
This API is subject to change or removal without notice. # IAM Permissions Requires the
dataflow.metrics.get permission on the job.
ProjectsResource.LocationsResource.JobsResource.UpdateRequest
Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we
recommend using projects.locations.jobs.update with a [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.update
is not recommended, as you can only update the state of jobs that are running in us-central1. #
IAM Permissions 1. Requires the dataflow.jobs.cancel permission to cancel a job. 2. Requires the
dataflow.jobs.updateContents permission to update runtime parameters.
ProjectsResource.LocationsResource.JobsResource.WorkItemsResource
The "workItems" collection of methods.
ProjectsResource.LocationsResource.JobsResource.WorkItemsResource.LeaseRequest
Leases a dataflow WorkItem to run.
ProjectsResource.LocationsResource.JobsResource.WorkItemsResource.ReportStatusRequest
Reports the status of dataflow WorkItems leased by a worker.
ProjectsResource.LocationsResource.SnapshotsResource
The "snapshots" collection of methods.
ProjectsResource.LocationsResource.SnapshotsResource.DeleteRequest
Deletes a snapshot.
ProjectsResource.LocationsResource.SnapshotsResource.GetRequest
Gets information about a snapshot.
ProjectsResource.LocationsResource.SnapshotsResource.ListRequest
Lists snapshots.
ProjectsResource.LocationsResource.TemplatesResource
The "templates" collection of methods.
ProjectsResource.LocationsResource.TemplatesResource.CreateRequest
Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply
string values using the API. To create a job, we recommend using
projects.locations.templates.create with a [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using
projects.templates.create is not recommended, because your job will always start in us-central1.
IAM Permissions Requires the following IAM permission(s) on the project: - dataflow.jobs.create
resourcemanager.projects.get
ProjectsResource.LocationsResource.TemplatesResource.GetRequest
Get the template associated with a template. To get the template, we recommend using
projects.locations.templates.get with a [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.templates.get
is not recommended, because only templates that are running in us-central1 are retrieved. # IAM
Permissions Requires the resourcemanager.projects.get permission on the project.
ProjectsResource.LocationsResource.TemplatesResource.LaunchRequest
Launches a template. To launch a template, we recommend using projects.locations.templates.launch
with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints).
Using projects.templates.launch is not recommended, because jobs launched from the template will
always start in us-central1. # IAM Permissions Requires the following IAM permission(s) on the
project: - dataflow.jobs.create - resourcemanager.projects.get
ProjectsResource.LocationsResource.WorkerMessagesRequest
Send a worker_message to the service.
ProjectsResource.SnapshotsResource
The "snapshots" collection of methods.
ProjectsResource.SnapshotsResource.GetRequest
Gets information about a snapshot.
ProjectsResource.SnapshotsResource.ListRequest
Lists snapshots.
ProjectsResource.TemplatesResource
The "templates" collection of methods.
ProjectsResource.TemplatesResource.CreateRequest
Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply
string values using the API. To create a job, we recommend using projects.locations.templates.create
with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using
projects.templates.create is not recommended, because your job will always start in us-central1. #
IAM Permissions Requires the following IAM permission(s) on the project: - dataflow.jobs.create -
resourcemanager.projects.get
ProjectsResource.TemplatesResource.GetRequest
Get the template associated with a template. To get the template, we recommend using
projects.locations.templates.get with a [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.templates.get is
not recommended, because only templates that are running in us-central1 are retrieved. # IAM
Permissions Requires the resourcemanager.projects.get permission on the project.
ProjectsResource.TemplatesResource.LaunchRequest
Launches a template. To launch a template, we recommend using projects.locations.templates.launch with
a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using
projects.templates.launch is not recommended, because jobs launched from the template will always
start in us-central1. # IAM Permissions Requires the following IAM permission(s) on the project: -
dataflow.jobs.create - resourcemanager.projects.get
ProjectsResource.WorkerMessagesRequest
Send a worker_message to the service.
Enums
DataflowBaseServiceRequest<TResponse>.AltEnum
Data format for response.
DataflowBaseServiceRequest<TResponse>.XgafvEnum
V1 error format.
ProjectsResource.JobsResource.AggregatedRequest.FilterEnum
The kind of filter to use.
ProjectsResource.JobsResource.AggregatedRequest.ViewEnum
Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.
ProjectsResource.JobsResource.CreateRequest.ViewEnum
The level of information requested in response.
ProjectsResource.JobsResource.GetRequest.ViewEnum
The level of information requested in response.
ProjectsResource.JobsResource.ListRequest.FilterEnum
The kind of filter to use.
ProjectsResource.JobsResource.ListRequest.ViewEnum
Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.
ProjectsResource.JobsResource.MessagesResource.ListRequest.MinimumImportanceEnum
Filter to only get messages with importance >= level
ProjectsResource.LocationsResource.JobsResource.CreateRequest.ViewEnum
The level of information requested in response.
ProjectsResource.LocationsResource.JobsResource.GetRequest.ViewEnum
The level of information requested in response.
ProjectsResource.LocationsResource.JobsResource.ListRequest.FilterEnum
The kind of filter to use.
ProjectsResource.LocationsResource.JobsResource.ListRequest.ViewEnum
Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.
ProjectsResource.LocationsResource.JobsResource.MessagesResource.ListRequest.MinimumImportanceEnum
Filter to only get messages with importance >= level
ProjectsResource.LocationsResource.TemplatesResource.GetRequest.ViewEnum
The view to retrieve. Defaults to METADATA_ONLY.
ProjectsResource.TemplatesResource.GetRequest.ViewEnum
The view to retrieve. Defaults to METADATA_ONLY.