com.google.cloud.dataproc.v1.SessionOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dataproc-v1 Show documentation
Show all versions of proto-google-cloud-dataproc-v1 Show documentation
PROTO library for proto-google-cloud-dataproc-v1
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dataproc/v1/sessions.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.dataproc.v1;
public interface SessionOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.Session)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. The resource name of the session.
*
*
* string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Required. The resource name of the session.
*
*
* string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. A session UUID (Unique Universal Identifier). The service
* generates this value when it creates the session.
*
*
* string uuid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The uuid.
*/
java.lang.String getUuid();
/**
*
*
*
* Output only. A session UUID (Unique Universal Identifier). The service
* generates this value when it creates the session.
*
*
* string uuid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for uuid.
*/
com.google.protobuf.ByteString getUuidBytes();
/**
*
*
*
* Output only. The time when the session was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time when the session was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The time when the session was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Optional. Jupyter session config.
*
*
*
* .google.cloud.dataproc.v1.JupyterConfig jupyter_session = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the jupyterSession field is set.
*/
boolean hasJupyterSession();
/**
*
*
*
* Optional. Jupyter session config.
*
*
*
* .google.cloud.dataproc.v1.JupyterConfig jupyter_session = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The jupyterSession.
*/
com.google.cloud.dataproc.v1.JupyterConfig getJupyterSession();
/**
*
*
*
* Optional. Jupyter session config.
*
*
*
* .google.cloud.dataproc.v1.JupyterConfig jupyter_session = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.JupyterConfigOrBuilder getJupyterSessionOrBuilder();
/**
*
*
*
* Optional. Spark Connect session config.
*
*
*
* .google.cloud.dataproc.v1.SparkConnectConfig spark_connect_session = 17 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the sparkConnectSession field is set.
*/
boolean hasSparkConnectSession();
/**
*
*
*
* Optional. Spark Connect session config.
*
*
*
* .google.cloud.dataproc.v1.SparkConnectConfig spark_connect_session = 17 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The sparkConnectSession.
*/
com.google.cloud.dataproc.v1.SparkConnectConfig getSparkConnectSession();
/**
*
*
*
* Optional. Spark Connect session config.
*
*
*
* .google.cloud.dataproc.v1.SparkConnectConfig spark_connect_session = 17 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.SparkConnectConfigOrBuilder getSparkConnectSessionOrBuilder();
/**
*
*
*
* Output only. Runtime information about session execution.
*
*
*
* .google.cloud.dataproc.v1.RuntimeInfo runtime_info = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the runtimeInfo field is set.
*/
boolean hasRuntimeInfo();
/**
*
*
*
* Output only. Runtime information about session execution.
*
*
*
* .google.cloud.dataproc.v1.RuntimeInfo runtime_info = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The runtimeInfo.
*/
com.google.cloud.dataproc.v1.RuntimeInfo getRuntimeInfo();
/**
*
*
*
* Output only. Runtime information about session execution.
*
*
*
* .google.cloud.dataproc.v1.RuntimeInfo runtime_info = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dataproc.v1.RuntimeInfoOrBuilder getRuntimeInfoOrBuilder();
/**
*
*
*
* Output only. A state of the session.
*
*
*
* .google.cloud.dataproc.v1.Session.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. A state of the session.
*
*
*
* .google.cloud.dataproc.v1.Session.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.dataproc.v1.Session.State getState();
/**
*
*
*
* Output only. Session state details, such as the failure
* description if the state is `FAILED`.
*
*
* string state_message = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The stateMessage.
*/
java.lang.String getStateMessage();
/**
*
*
*
* Output only. Session state details, such as the failure
* description if the state is `FAILED`.
*
*
* string state_message = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for stateMessage.
*/
com.google.protobuf.ByteString getStateMessageBytes();
/**
*
*
*
* Output only. The time when the session entered the current state.
*
*
* .google.protobuf.Timestamp state_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the stateTime field is set.
*/
boolean hasStateTime();
/**
*
*
*
* Output only. The time when the session entered the current state.
*
*
* .google.protobuf.Timestamp state_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The stateTime.
*/
com.google.protobuf.Timestamp getStateTime();
/**
*
*
*
* Output only. The time when the session entered the current state.
*
*
* .google.protobuf.Timestamp state_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getStateTimeOrBuilder();
/**
*
*
*
* Output only. The email address of the user who created the session.
*
*
* string creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The creator.
*/
java.lang.String getCreator();
/**
*
*
*
* Output only. The email address of the user who created the session.
*
*
* string creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for creator.
*/
com.google.protobuf.ByteString getCreatorBytes();
/**
*
*
*
* Optional. The labels to associate with the session.
* Label **keys** must contain 1 to 63 characters, and must conform to
* [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
* Label **values** may be empty, but, if present, must contain 1 to 63
* characters, and must conform to [RFC
* 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
* associated with a session.
*
*
* map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
*/
int getLabelsCount();
/**
*
*
*
* Optional. The labels to associate with the session.
* Label **keys** must contain 1 to 63 characters, and must conform to
* [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
* Label **values** may be empty, but, if present, must contain 1 to 63
* characters, and must conform to [RFC
* 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
* associated with a session.
*
*
* map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Optional. The labels to associate with the session.
* Label **keys** must contain 1 to 63 characters, and must conform to
* [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
* Label **values** may be empty, but, if present, must contain 1 to 63
* characters, and must conform to [RFC
* 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
* associated with a session.
*
*
* map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Optional. The labels to associate with the session.
* Label **keys** must contain 1 to 63 characters, and must conform to
* [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
* Label **values** may be empty, but, if present, must contain 1 to 63
* characters, and must conform to [RFC
* 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
* associated with a session.
*
*
* map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Optional. The labels to associate with the session.
* Label **keys** must contain 1 to 63 characters, and must conform to
* [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
* Label **values** may be empty, but, if present, must contain 1 to 63
* characters, and must conform to [RFC
* 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
* associated with a session.
*
*
* map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Optional. Runtime configuration for the session execution.
*
*
*
* .google.cloud.dataproc.v1.RuntimeConfig runtime_config = 12 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the runtimeConfig field is set.
*/
boolean hasRuntimeConfig();
/**
*
*
*
* Optional. Runtime configuration for the session execution.
*
*
*
* .google.cloud.dataproc.v1.RuntimeConfig runtime_config = 12 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The runtimeConfig.
*/
com.google.cloud.dataproc.v1.RuntimeConfig getRuntimeConfig();
/**
*
*
*
* Optional. Runtime configuration for the session execution.
*
*
*
* .google.cloud.dataproc.v1.RuntimeConfig runtime_config = 12 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.RuntimeConfigOrBuilder getRuntimeConfigOrBuilder();
/**
*
*
*
* Optional. Environment configuration for the session execution.
*
*
*
* .google.cloud.dataproc.v1.EnvironmentConfig environment_config = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the environmentConfig field is set.
*/
boolean hasEnvironmentConfig();
/**
*
*
*
* Optional. Environment configuration for the session execution.
*
*
*
* .google.cloud.dataproc.v1.EnvironmentConfig environment_config = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The environmentConfig.
*/
com.google.cloud.dataproc.v1.EnvironmentConfig getEnvironmentConfig();
/**
*
*
*
* Optional. Environment configuration for the session execution.
*
*
*
* .google.cloud.dataproc.v1.EnvironmentConfig environment_config = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.EnvironmentConfigOrBuilder getEnvironmentConfigOrBuilder();
/**
*
*
*
* Optional. The email address of the user who owns the session.
*
*
* string user = 14 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The user.
*/
java.lang.String getUser();
/**
*
*
*
* Optional. The email address of the user who owns the session.
*
*
* string user = 14 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for user.
*/
com.google.protobuf.ByteString getUserBytes();
/**
*
*
*
* Output only. Historical state information for the session.
*
*
*
* repeated .google.cloud.dataproc.v1.Session.SessionStateHistory state_history = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List getStateHistoryList();
/**
*
*
*
* Output only. Historical state information for the session.
*
*
*
* repeated .google.cloud.dataproc.v1.Session.SessionStateHistory state_history = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dataproc.v1.Session.SessionStateHistory getStateHistory(int index);
/**
*
*
*
* Output only. Historical state information for the session.
*
*
*
* repeated .google.cloud.dataproc.v1.Session.SessionStateHistory state_history = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
int getStateHistoryCount();
/**
*
*
*
* Output only. Historical state information for the session.
*
*
*
* repeated .google.cloud.dataproc.v1.Session.SessionStateHistory state_history = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List
getStateHistoryOrBuilderList();
/**
*
*
*
* Output only. Historical state information for the session.
*
*
*
* repeated .google.cloud.dataproc.v1.Session.SessionStateHistory state_history = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dataproc.v1.Session.SessionStateHistoryOrBuilder getStateHistoryOrBuilder(
int index);
/**
*
*
*
* Optional. The session template used by the session.
*
* Only resource names, including project ID and location, are valid.
*
* Example:
* * `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]`
* * `projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]`
*
* The template must be in the same project and Dataproc region as the
* session.
*
*
*
* string session_template = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
*
*
* @return The sessionTemplate.
*/
java.lang.String getSessionTemplate();
/**
*
*
*
* Optional. The session template used by the session.
*
* Only resource names, including project ID and location, are valid.
*
* Example:
* * `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]`
* * `projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]`
*
* The template must be in the same project and Dataproc region as the
* session.
*
*
*
* string session_template = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for sessionTemplate.
*/
com.google.protobuf.ByteString getSessionTemplateBytes();
com.google.cloud.dataproc.v1.Session.SessionConfigCase getSessionConfigCase();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy