Class: Google::Cloud::Dataplex::V1::SessionEvent

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/logs.rb

Overview

These messages contain information about sessions within an environment. The monitored resource is 'Environment'.

Defined Under Namespace

Modules: EventType Classes: QueryDetail

Instance Attribute Summary collapse

Instance Attribute Details

#event_succeeded ⇒ ::Boolean

Returns The status of the event.

Returns:

  • (::Boolean) —

    The status of the event.



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 281

class SessionEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Execution details of the query.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     The unique Query id identifying the query.
  # @!attribute [rw] query_text
  #   @return [::String]
  #     The query text executed.
  # @!attribute [rw] engine
  #   @return [::Google::Cloud::Dataplex::V1::SessionEvent::QueryDetail::Engine]
  #     Query Execution engine.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Time taken for execution of the query.
  # @!attribute [rw] result_size_bytes
  #   @return [::Integer]
  #     The size of results the query produced.
  # @!attribute [rw] data_processed_bytes
  #   @return [::Integer]
  #     The data processed by the query.
  class QueryDetail
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Query Execution engine.
    module Engine
      # An unspecified Engine type.
      ENGINE_UNSPECIFIED = 0

      # Spark-sql engine is specified in Query.
      SPARK_SQL = 1

      # BigQuery engine is specified in Query.
      BIGQUERY = 2
    end
  end

  # The type of the event.
  module EventType
    # An unspecified event type.
    EVENT_TYPE_UNSPECIFIED = 0

    # Event when the session is assigned to a user.
    START = 1

    # Event for stop of a session.
    STOP = 2

    # Query events in the session.
    QUERY = 3

    # Event for creation of a cluster. It is not yet assigned to a user.
    # This comes before START in the sequence
    CREATE = 4
  end
end

#fast_startup_enabled ⇒ ::Boolean

Returns If the session is associated with an environment with fast startup enabled, and was created before being assigned to a user.

Returns:

  • (::Boolean) —

    If the session is associated with an environment with fast startup enabled, and was created before being assigned to a user.



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 281

class SessionEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Execution details of the query.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     The unique Query id identifying the query.
  # @!attribute [rw] query_text
  #   @return [::String]
  #     The query text executed.
  # @!attribute [rw] engine
  #   @return [::Google::Cloud::Dataplex::V1::SessionEvent::QueryDetail::Engine]
  #     Query Execution engine.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Time taken for execution of the query.
  # @!attribute [rw] result_size_bytes
  #   @return [::Integer]
  #     The size of results the query produced.
  # @!attribute [rw] data_processed_bytes
  #   @return [::Integer]
  #     The data processed by the query.
  class QueryDetail
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Query Execution engine.
    module Engine
      # An unspecified Engine type.
      ENGINE_UNSPECIFIED = 0

      # Spark-sql engine is specified in Query.
      SPARK_SQL = 1

      # BigQuery engine is specified in Query.
      BIGQUERY = 2
    end
  end

  # The type of the event.
  module EventType
    # An unspecified event type.
    EVENT_TYPE_UNSPECIFIED = 0

    # Event when the session is assigned to a user.
    START = 1

    # Event for stop of a session.
    STOP = 2

    # Query events in the session.
    QUERY = 3

    # Event for creation of a cluster. It is not yet assigned to a user.
    # This comes before START in the sequence
    CREATE = 4
  end
end

#message ⇒ ::String

Returns The log message.

Returns:

  • (::String) —

    The log message.



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 281

class SessionEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Execution details of the query.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     The unique Query id identifying the query.
  # @!attribute [rw] query_text
  #   @return [::String]
  #     The query text executed.
  # @!attribute [rw] engine
  #   @return [::Google::Cloud::Dataplex::V1::SessionEvent::QueryDetail::Engine]
  #     Query Execution engine.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Time taken for execution of the query.
  # @!attribute [rw] result_size_bytes
  #   @return [::Integer]
  #     The size of results the query produced.
  # @!attribute [rw] data_processed_bytes
  #   @return [::Integer]
  #     The data processed by the query.
  class QueryDetail
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Query Execution engine.
    module Engine
      # An unspecified Engine type.
      ENGINE_UNSPECIFIED = 0

      # Spark-sql engine is specified in Query.
      SPARK_SQL = 1

      # BigQuery engine is specified in Query.
      BIGQUERY = 2
    end
  end

  # The type of the event.
  module EventType
    # An unspecified event type.
    EVENT_TYPE_UNSPECIFIED = 0

    # Event when the session is assigned to a user.
    START = 1

    # Event for stop of a session.
    STOP = 2

    # Query events in the session.
    QUERY = 3

    # Event for creation of a cluster. It is not yet assigned to a user.
    # This comes before START in the sequence
    CREATE = 4
  end
end

#query ⇒ ::Google::Cloud::Dataplex::V1::SessionEvent::QueryDetail

Returns The execution details of the query.

Returns:



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 281

class SessionEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Execution details of the query.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     The unique Query id identifying the query.
  # @!attribute [rw] query_text
  #   @return [::String]
  #     The query text executed.
  # @!attribute [rw] engine
  #   @return [::Google::Cloud::Dataplex::V1::SessionEvent::QueryDetail::Engine]
  #     Query Execution engine.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Time taken for execution of the query.
  # @!attribute [rw] result_size_bytes
  #   @return [::Integer]
  #     The size of results the query produced.
  # @!attribute [rw] data_processed_bytes
  #   @return [::Integer]
  #     The data processed by the query.
  class QueryDetail
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Query Execution engine.
    module Engine
      # An unspecified Engine type.
      ENGINE_UNSPECIFIED = 0

      # Spark-sql engine is specified in Query.
      SPARK_SQL = 1

      # BigQuery engine is specified in Query.
      BIGQUERY = 2
    end
  end

  # The type of the event.
  module EventType
    # An unspecified event type.
    EVENT_TYPE_UNSPECIFIED = 0

    # Event when the session is assigned to a user.
    START = 1

    # Event for stop of a session.
    STOP = 2

    # Query events in the session.
    QUERY = 3

    # Event for creation of a cluster. It is not yet assigned to a user.
    # This comes before START in the sequence
    CREATE = 4
  end
end

#session_id ⇒ ::String

Returns Unique identifier for the session.

Returns:

  • (::String) —

    Unique identifier for the session.



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 281

class SessionEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Execution details of the query.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     The unique Query id identifying the query.
  # @!attribute [rw] query_text
  #   @return [::String]
  #     The query text executed.
  # @!attribute [rw] engine
  #   @return [::Google::Cloud::Dataplex::V1::SessionEvent::QueryDetail::Engine]
  #     Query Execution engine.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Time taken for execution of the query.
  # @!attribute [rw] result_size_bytes
  #   @return [::Integer]
  #     The size of results the query produced.
  # @!attribute [rw] data_processed_bytes
  #   @return [::Integer]
  #     The data processed by the query.
  class QueryDetail
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Query Execution engine.
    module Engine
      # An unspecified Engine type.
      ENGINE_UNSPECIFIED = 0

      # Spark-sql engine is specified in Query.
      SPARK_SQL = 1

      # BigQuery engine is specified in Query.
      BIGQUERY = 2
    end
  end

  # The type of the event.
  module EventType
    # An unspecified event type.
    EVENT_TYPE_UNSPECIFIED = 0

    # Event when the session is assigned to a user.
    START = 1

    # Event for stop of a session.
    STOP = 2

    # Query events in the session.
    QUERY = 3

    # Event for creation of a cluster. It is not yet assigned to a user.
    # This comes before START in the sequence
    CREATE = 4
  end
end

#type ⇒ ::Google::Cloud::Dataplex::V1::SessionEvent::EventType

Returns The type of the event.

Returns:



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 281

class SessionEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Execution details of the query.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     The unique Query id identifying the query.
  # @!attribute [rw] query_text
  #   @return [::String]
  #     The query text executed.
  # @!attribute [rw] engine
  #   @return [::Google::Cloud::Dataplex::V1::SessionEvent::QueryDetail::Engine]
  #     Query Execution engine.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Time taken for execution of the query.
  # @!attribute [rw] result_size_bytes
  #   @return [::Integer]
  #     The size of results the query produced.
  # @!attribute [rw] data_processed_bytes
  #   @return [::Integer]
  #     The data processed by the query.
  class QueryDetail
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Query Execution engine.
    module Engine
      # An unspecified Engine type.
      ENGINE_UNSPECIFIED = 0

      # Spark-sql engine is specified in Query.
      SPARK_SQL = 1

      # BigQuery engine is specified in Query.
      BIGQUERY = 2
    end
  end

  # The type of the event.
  module EventType
    # An unspecified event type.
    EVENT_TYPE_UNSPECIFIED = 0

    # Event when the session is assigned to a user.
    START = 1

    # Event for stop of a session.
    STOP = 2

    # Query events in the session.
    QUERY = 3

    # Event for creation of a cluster. It is not yet assigned to a user.
    # This comes before START in the sequence
    CREATE = 4
  end
end

#unassigned_duration ⇒ ::Google::Protobuf::Duration

Returns The idle duration of a warm pooled session before it is assigned to user.

Returns:



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 281

class SessionEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Execution details of the query.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     The unique Query id identifying the query.
  # @!attribute [rw] query_text
  #   @return [::String]
  #     The query text executed.
  # @!attribute [rw] engine
  #   @return [::Google::Cloud::Dataplex::V1::SessionEvent::QueryDetail::Engine]
  #     Query Execution engine.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Time taken for execution of the query.
  # @!attribute [rw] result_size_bytes
  #   @return [::Integer]
  #     The size of results the query produced.
  # @!attribute [rw] data_processed_bytes
  #   @return [::Integer]
  #     The data processed by the query.
  class QueryDetail
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Query Execution engine.
    module Engine
      # An unspecified Engine type.
      ENGINE_UNSPECIFIED = 0

      # Spark-sql engine is specified in Query.
      SPARK_SQL = 1

      # BigQuery engine is specified in Query.
      BIGQUERY = 2
    end
  end

  # The type of the event.
  module EventType
    # An unspecified event type.
    EVENT_TYPE_UNSPECIFIED = 0

    # Event when the session is assigned to a user.
    START = 1

    # Event for stop of a session.
    STOP = 2

    # Query events in the session.
    QUERY = 3

    # Event for creation of a cluster. It is not yet assigned to a user.
    # This comes before START in the sequence
    CREATE = 4
  end
end

#user_id ⇒ ::String

Returns The information about the user that created the session. It will be the email address of the user.

Returns:

  • (::String) —

    The information about the user that created the session. It will be the email address of the user.



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'proto_docs/google/cloud/dataplex/v1/logs.rb', line 281

class SessionEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Execution details of the query.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     The unique Query id identifying the query.
  # @!attribute [rw] query_text
  #   @return [::String]
  #     The query text executed.
  # @!attribute [rw] engine
  #   @return [::Google::Cloud::Dataplex::V1::SessionEvent::QueryDetail::Engine]
  #     Query Execution engine.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Time taken for execution of the query.
  # @!attribute [rw] result_size_bytes
  #   @return [::Integer]
  #     The size of results the query produced.
  # @!attribute [rw] data_processed_bytes
  #   @return [::Integer]
  #     The data processed by the query.
  class QueryDetail
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Query Execution engine.
    module Engine
      # An unspecified Engine type.
      ENGINE_UNSPECIFIED = 0

      # Spark-sql engine is specified in Query.
      SPARK_SQL = 1

      # BigQuery engine is specified in Query.
      BIGQUERY = 2
    end
  end

  # The type of the event.
  module EventType
    # An unspecified event type.
    EVENT_TYPE_UNSPECIFIED = 0

    # Event when the session is assigned to a user.
    START = 1

    # Event for stop of a session.
    STOP = 2

    # Query events in the session.
    QUERY = 3

    # Event for creation of a cluster. It is not yet assigned to a user.
    # This comes before START in the sequence
    CREATE = 4
  end
end