Package google.cloud.managedflink.v1alpha

Preview

This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA products and features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Index

• ManagedFlink (interface)
• AutotuningConfig (message)
• AutotuningConfig.Elastic (message)
• AutotuningConfig.Fixed (message)
• CreateDeploymentRequest (message)
• CreateJobRequest (message)
• CreateSessionRequest (message)
• DeleteDeploymentRequest (message)
• DeleteJobRequest (message)
• DeleteSessionRequest (message)
• Deployment (message)
• Deployment.State (enum)
• DeploymentSpec (message)
• DisplayGraph (message)
• DisplayGraph.State (enum)
• GetDeploymentRequest (message)
• GetJobRequest (message)
• GetSessionRequest (message)
• Job (message)
• Job.State (enum)
• JobSpec (message)
• Limits (message)
• ListDeploymentsRequest (message)
• ListDeploymentsResponse (message)
• ListJobsRequest (message)
• ListJobsResponse (message)
• ListSessionsRequest (message)
• ListSessionsResponse (message)
• ManagedKafkaConfig (message)
• NetworkConfig (message)
• OperationMetadata (message)
• Session (message)
• StagingLocation (message)
• UpdateDeploymentRequest (message)
• UpdateJobRequest (message)
• UpdateSessionRequest (message)

ManagedFlink

Service describing handlers for resources

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Operation) Creates a new deployment in the specified project and location. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: managedflink.deployments.create For more information, see the IAM documentation.

CreateJob

rpc CreateJob(CreateJobRequest) returns (Operation) Creates a new job in the specified project and location. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: managedflink.jobs.create For more information, see the IAM documentation.

CreateSession

rpc CreateSession(CreateSessionRequest) returns (Operation) Creates a new session in the specified project and location. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: managedflink.sessions.create For more information, see the IAM documentation.

DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Operation) Deletes a single deployment. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: managedflink.deployments.delete For more information, see the IAM documentation.

DeleteJob
rpc DeleteJob(DeleteJobRequest) returns (Operation) Deletes a single job. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: managedflink.jobs.delete For more information, see the IAM documentation.

DeleteSession
rpc DeleteSession(DeleteSessionRequest) returns (Operation) Deletes a single session. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: managedflink.sessions.delete For more information, see the IAM documentation.

GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment) Gets details about a single deployment. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: managedflink.deployments.get For more information, see the IAM documentation.

GetJob
rpc GetJob(GetJobRequest) returns (Job) Gets details of a single job. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: managedflink.jobs.get For more information, see the IAM documentation.

GetSession
rpc GetSession(GetSessionRequest) returns (Session) Gets details of a single session. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: managedflink.sessions.get For more information, see the IAM documentation.

ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse) Lists deployments in the specified project and location. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: managedflink.deployments.list For more information, see the IAM documentation.

ListJobs

rpc ListJobs(ListJobsRequest) returns (ListJobsResponse) Lists jobs in the specified project and location. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: managedflink.jobs.list For more information, see the IAM documentation.

ListSessions

rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse) Lists sessions in the specified project and location. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: managedflink.sessions.list For more information, see the IAM documentation.

UpdateDeployment

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Operation) Updates the parameters of a single deployment. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: managedflink.deployments.update For more information, see the IAM documentation.

UpdateJob

rpc UpdateJob(UpdateJobRequest) returns (Operation) Updates the parameters of a single job. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: managedflink.jobs.update For more information, see the IAM documentation.

UpdateSession

rpc UpdateSession(UpdateSessionRequest) returns (Operation) Updates the parameters of a single session. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: managedflink.sessions.update For more information, see the IAM documentation.

AutotuningConfig

The autotuning configuration for the Apache Flink job.

Fields
Union field horizontal_autoscaling_policy. The horizontal autoscaling policy for the job. horizontal_autoscaling_policy can be only one of the following:
fixed	Fixed Fixed policy to disable autoscaling.
throughput_based	Elastic The throughput-based autoscaling policy that leverages observed throughput and true processing rate (estimated maximum achievable throughput) to autoscale the task parallelism per job vertex.

Elastic

Elastic autoscaling policy to enable autoscaling with min/max limits.

Fields
parallelism	int32 Optional. The initial task parallelism for the job.
min_parallelism	int32 Optional. The minimum task parallelism for the job.
max_parallelism	int32 Optional. The maximum task parallelism for the job.

Fixed

Fixed policy to disable autoscaling.

Fields
parallelism	int32 Optional. The fixed task parallelism for the job.

CreateDeploymentRequest

Message for creating a BigQuery Engine for Apache Flink deployment.

Fields
parent	string Required. The parent region in which to create the deployment, specified in the following format: projects/{project}/locations/{location}.
deployment_id	string Required. ID of the requesting object. If auto-generating ID server-side, remove this field and deployment_id from the method_signature of Create RPC
deployment	Deployment Required. The resource being created.
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received. If the request was received, the server ignores the second request. This behavior prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateJobRequest

Message for creating a job.

Fields
parent	string Required. The parent region in which to create the job, specified in the following format: projects/{project}/locations/{location}.
job_id	string Required. The ID to use for the job, which becomes the final component of the job's name.
job	Job Required. Configuration of the job to create. The name field is ignored.
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received. If the request was received, the server ignores the second request. This behavior prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateSessionRequest

Message for creating a session.

Fields
parent	string Required. The parent region in which to create the session, specified in the following format: projects/{project}/locations/{location}.
session_id	string Required. ID to use for the session.
session	Session Required. The session being created.
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received. If the request was received, the server ignores the second request. This behavior prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteDeploymentRequest

Message for deleting a BigQuery Engine for Apache Flink deployment.

Fields
name	string Required. Name of the resource.
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received. If the request was received, the server ignores the second request. This behavior prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteJobRequest

Message for deleting a job.

Fields
name	string Required. Name of the resource.
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received. If the request was received, the server ignores the second request. This behavior prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteSessionRequest

Message for deleting a session.

Fields
name	string Required. Name of the session, specified in the following format: projects/{project}/locations/{location}/sessions/{session}
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received. If the request was received, the server ignores the second request. This behavior prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Deployment

Describes a BigQuery Engine for Apache Flink deployment resource.

Fields
name	string Identifier. The name of the deployment.
display_name	string Optional. The display name of the deployment.
state	State Output only. The state of the deployment.
create_time	Timestamp Output only. The time when the deployment was created.
update_time	Timestamp Output only. The time when the deployment was last updated.
labels	map<string, string> Optional. Labels as key value pairs.
deployment_spec	DeploymentSpec Optional. Spec that describes a deployment.

State

Enum defining the states of a deployment.

Enums
STATE_UNSPECIFIED	State unspecified.
INITIALIZING	Deployment is initializing.
CREATED	Deployment has been created.
RUNNING	Deployment is running.
TERMINATING	Deployment is terminating.
TERMINATED	Deployment has terminated.

DeploymentSpec

The specification of a deployment.

Fields
network_config	NetworkConfig Optional. Network configuration for the deployment.
limits	Limits Optional. The limit constraints for the deployment.
secrets_paths[]	string Optional. Not currently supported. The paths to the secrets to be associated with this deployment.

DisplayGraph

The Apache Flink display graph of the job.

Fields
display_graph_json	string Output only. The display graph in JSON format.
state	State Output only. The state of the display graph.

State

Enum defining the states of a display graph.

Enums
STATE_UNSPECIFIED	Display graph state unspecified.
DISPLAY_GRAPH_POPULATED	Display graph is populated.
DISPLAY_GRAPH_TOO_LARGE	Display graph is too large.
DISPLAY_GRAPH_EMPTY	Display graph is empty.

GetDeploymentRequest

Message for getting a deployment.

Fields
name	string Required. Name of the resource.

GetJobRequest

Message for getting a job.

Fields
name	string Required. Name of the resource.

GetSessionRequest

Message for getting a session.

Fields
name	string Required. Name of the resource.

Job

Describes a BigQuery Engine for Apache Flink job resource.

Fields
name	string Identifier. The name of the job.
state	State Output only. The state of the Apache Flink job.
create_time	Timestamp Output only. The time when the job was created.
update_time	Timestamp Output only. The time when the job was last updated.
labels	map<string, string> Optional. User defined labels as key value pairs.
deployment_id	string Optional. The deployment that this job belongs to. If empty, the job is created in an ephemeral on-demand Apache Flink cluster.
job_spec	JobSpec Required. The specification of the Apache Flink job.
display_graph	DisplayGraph Output only. The display graph of the Apache Flink job. This is only populated on a GetAPI call. It is not populated on a ListAPI call.

State

The states of an Apache Flink job. The states are based on the Apache Flink REST API.

Enums
STATE_UNSPECIFIED	State unspecified.
PENDING_CREATION	Job is pending creation.
INITIALIZING	Job is initializing.
CREATED	Job has been created.
RUNNING	Job is running.
FAILING	Job is failing.
FAILED	Job has failed.
CANCELLING	Job is getting cancelled.
CANCELLED	Job has been cancelled.
FINISHED	Job has finished.
RESTARTING	Job is restarting.
SUSPENDED	Job has been suspended.
RECONCILING	Job is reconciling.

JobSpec

The specification of the Apache Flink job.

Fields
jar_uris[]	string Optional. The list of URIs for the job JARs in Cloud Storage.
job_graph_uri	string Required. The job graph URI in Cloud Storage.
artifact_uris[]	string Required. The list of URIs for the job artifact files in Cloud Storage.
autotuning_config	AutotuningConfig Optional. Autotuning configuration for the job.
network_config	NetworkConfig Optional. Network configuration for the job.
display_name	string Optional. Display name of the job. This name is explicitly set by the user.
job_name	string Optional. Job name of the job. The client automatically derives this name from the job graph.
managed_kafka_config	ManagedKafkaConfig Optional. The configuration for the Google Cloud Managed Service for Apache Kafka clusters to be used by the job.
job_graph_encoding	string Optional. The encoding type of the job graph.

Limits

The limit constraints of the deployment. The limits are based on the upper bounds for the different underlying resources.

Fields
max_slots	int64 Optional. The maximum number of slots for the deployment.

ListDeploymentsRequest

Message for requesting list of deployments.

Fields
parent	string Required. Parent value for ListDeploymentsRequest. The value is the location, specified in the following format: projects/{project}/locations/{location}.
page_size	int32 Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.
page_token	string Optional. A token that identifies a page of results that the server should return.
filter	string Optional. An expression to filter the list of returned deployments. The expression must use the syntax as documented in AIP-160.
order_by	string Optional. A hint for how to order the results. The hint must be specified as documented in AIP-132.

ListDeploymentsResponse

Response to the request to list deployments.

Fields
deployments[]	Deployment The list of deployments.
next_page_token	string A token that identifies a page of results that the server should return.
unreachable[]	string Locations that could not be reached.

ListJobsRequest

Message for requesting a list of jobs.

Fields
parent	string Required. Parent value for ListJobsRequest. The value is the location, specified in the following format: projects/{project}/locations/{location}.
page_size	int32 Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.
page_token	string Optional. A token that identifies a page of results that the server should return.
filter	string Optional. An expression to filter the list of returned jobs. The expression must use the syntax as documented in AIP-160.
order_by	string Optional. A hint for how to order the results. The hint must be specified as documented in AIP-132.

ListJobsResponse

Response to the request to list jobs.

Fields
jobs[]	Job The list of jobs.
next_page_token	string A token that identifies a page of results that the server should return.
unreachable[]	string Locations that could not be reached.

ListSessionsRequest

Message for requesting list of sessions.

Fields
parent	string Required. Parent value for ListSessionsRequest. The value is the location, specified in the following format: projects/{project}/locations/{location}.
page_size	int32 Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.
page_token	string Optional. A token that identifies a page of results that the server should return.
filter	string Optional. An expression to filter the list of returned sessions. For example, you can filter for active sessions. The expression must use the syntax as documented in AIP-160.
order_by	string Optional. A hint for how to order the results. For example, you can order by time of creation or last change. The hint must be specified as documented in AIP-132.

ListSessionsResponse

Message for response to listing sessions.

Fields
sessions[]	Session The list of sessions.
next_page_token	string The maximum number of sessions to return. The server might return fewer items than requested. If unspecified, at most 50 sessions are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
unreachable[]	string Locations that could not be reached.

ManagedKafkaConfig

The configuration for the Google Cloud Managed Service for Apache Kafka clusters to be used by the job.

Fields
managed_kafka_clusters[]	string Optional. The list of Managed Service for Apache Kafka clusters connected to the job, specified in the following format: projects/<project-id>/locations/<region>/clusters/<cluster-name>.

NetworkConfig

The VPC, region, and subnetwork that can connect to the BigQuery Engine for Apache Flink cluster.

Fields
vpc	string Optional. The name of the VPC Network to associate the BigQuery Engine for Apache Flink resources with, specified in the following format: projects/{project}/global/networks/{network_id}.
subnetwork	string Optional. The subnetwork of the resource.

OperationMetadata

Represents the metadata of a long-running operation.

Fields
create_time	Timestamp Output only. The time the operation was created.
end_time	Timestamp Output only. The time the operation finished running.
target	string Output only. Server-defined resource path for the target of the operation.
verb	string Output only. Name of the verb executed by the operation.
status_message	string Output only. Human-readable status of the operation, if any.
requested_cancellation	bool Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
api_version	string Output only. API version used to start the operation.

Session

Describes an Apache Flink session object.

Fields
name	string Identifier. Name of the resource.
create_time	Timestamp Output only. [Output only] Create timestamp.
update_time	Timestamp Output only. [Output only] Update timestamp.
labels	map<string, string> Optional. Labels as key value pairs.
staging_location	StagingLocation Optional. The staging location for artifacts in the session. This location can either be provided by the user, or the system will generate a default staging location.

StagingLocation

The staging location for artifacts in an Apache Flink session.

Fields
bucker_provider	string Optional. The type of bucket used for staging artifacts in the session.
bucket	string Optional. The bucket to use for staging artifacts in the session.
path	string Optional. The path within the bucket to use for staging artifacts in the session.

UpdateDeploymentRequest

Message for updating a BigQuery Engine for Apache Flink deployment.

Fields
update_mask	FieldMask Required. The field mask is used to specify the fields to be overwritten in the deployment resource by the update. The fields specified in update_mask are relative to the resource, not to the full request. A field is overwritten if it's in the mask. If you don't provide a mask, then all fields are overwritten.
deployment	Deployment Required. The resource being updated.
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received. If the request was received, the server ignores the second request. This behavior prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

UpdateJobRequest

Message for updating a job.

Fields
update_mask	FieldMask Required. The field mask is used to specify the fields to be overwritten in the job resource by the update. The fields specified in update_mask are relative to the resource, not to the full request. A field is overwritten if it's in the mask. If you don't provide a mask, then all fields are overwritten.
job	Job Required. The resource being updated.
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received. If the request was received, the server ignores the second request. This behavior prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

UpdateSessionRequest

Message for updating a session.

Fields
session	Session Required. The session being updated.
update_mask	FieldMask Required. The field mask is used to specify the fields to be overwritten in the session resource by the update. The fields specified in update_mask are relative to the resource, not to the full request. A field is overwritten if it's in the mask. If you don't provide a mask, then all fields are overwritten.
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received. If the request was received, the server ignores the second request. This behavior prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).