Class SessionTemplateControllerClient (2.27.0)

Version 2.27.0

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

The SessionTemplateController provides methods to manage session templates.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

SessionTemplateControllerClient(SessionTemplateControllerClient const &)

Copy and move support

Parameter
Name	Description
	SessionTemplateControllerClient const &

SessionTemplateControllerClient(SessionTemplateControllerClient &&)

Copy and move support

Parameter
Name	Description
	SessionTemplateControllerClient &&

SessionTemplateControllerClient(std::shared_ptr< SessionTemplateControllerConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< SessionTemplateControllerConnection >
opts	Options

Operators

operator=(SessionTemplateControllerClient const &)

Copy and move support

Parameter
Name	Description
	SessionTemplateControllerClient const &

Returns
Type	Description
SessionTemplateControllerClient &

operator=(SessionTemplateControllerClient &&)

Copy and move support

Parameter
Name	Description
	SessionTemplateControllerClient &&

Returns
Type	Description
SessionTemplateControllerClient &

Functions

CreateSessionTemplate(std::string const &, google::cloud::dataproc::v1::SessionTemplate const &, Options)

Create a session template synchronously.

Parameters
Name	Description
parent	std::string const & Required. The parent resource where this session template will be created.
session_template	google::cloud::dataproc::v1::SessionTemplate const & Required. The session template to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dataproc::v1::SessionTemplate >	the result of the RPC. The response message type (google.cloud.dataproc.v1.SessionTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateSessionTemplate(google::cloud::dataproc::v1::CreateSessionTemplateRequest const &, Options)

Create a session template synchronously.

Parameters
Name	Description
request	google::cloud::dataproc::v1::CreateSessionTemplateRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataproc.v1.CreateSessionTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dataproc::v1::SessionTemplate >	the result of the RPC. The response message type (google.cloud.dataproc.v1.SessionTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateSessionTemplate(google::cloud::dataproc::v1::SessionTemplate const &, Options)

Updates the session template synchronously.

Parameters
Name	Description
session_template	google::cloud::dataproc::v1::SessionTemplate const & Required. The updated session template.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dataproc::v1::SessionTemplate >	the result of the RPC. The response message type (google.cloud.dataproc.v1.SessionTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateSessionTemplate(google::cloud::dataproc::v1::UpdateSessionTemplateRequest const &, Options)

Updates the session template synchronously.

Parameters
Name	Description
request	google::cloud::dataproc::v1::UpdateSessionTemplateRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataproc.v1.UpdateSessionTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dataproc::v1::SessionTemplate >	the result of the RPC. The response message type (google.cloud.dataproc.v1.SessionTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSessionTemplate(std::string const &, Options)

Gets the resource representation for a session template.

Parameters
Name	Description
name	std::string const & Required. The name of the session template to retrieve.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dataproc::v1::SessionTemplate >	the result of the RPC. The response message type (google.cloud.dataproc.v1.SessionTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSessionTemplate(google::cloud::dataproc::v1::GetSessionTemplateRequest const &, Options)

Gets the resource representation for a session template.

Parameters
Name	Description
request	google::cloud::dataproc::v1::GetSessionTemplateRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataproc.v1.GetSessionTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dataproc::v1::SessionTemplate >	the result of the RPC. The response message type (google.cloud.dataproc.v1.SessionTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListSessionTemplates(std::string const &, Options)

Lists session templates.

Parameters
Name	Description
parent	std::string const & Required. The parent that owns this collection of session templates.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dataproc::v1::SessionTemplate >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataproc.v1.SessionTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSessionTemplates(google::cloud::dataproc::v1::ListSessionTemplatesRequest, Options)

Lists session templates.

Parameters
Name	Description
request	google::cloud::dataproc::v1::ListSessionTemplatesRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataproc.v1.ListSessionTemplatesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dataproc::v1::SessionTemplate >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataproc.v1.SessionTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteSessionTemplate(std::string const &, Options)

Deletes a session template.

Parameters
Name	Description
name	std::string const & Required. The name of the session template resource to delete.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

DeleteSessionTemplate(google::cloud::dataproc::v1::DeleteSessionTemplateRequest const &, Options)

Deletes a session template.

Parameters
Name	Description
request	google::cloud::dataproc::v1::DeleteSessionTemplateRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataproc.v1.DeleteSessionTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.