Class: Google::Apis::ServicecontrolV1::AuditLog
- Inherits:
-
Object
- Object
- Google::Apis::ServicecontrolV1::AuditLog
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/servicecontrol_v1/classes.rb,
generated/google/apis/servicecontrol_v1/representations.rb,
generated/google/apis/servicecontrol_v1/representations.rb
Overview
Common audit log format for Google Cloud Platform API operations.
Instance Attribute Summary collapse
-
#authentication_info ⇒ Google::Apis::ServicecontrolV1::AuthenticationInfo
Authentication information for the operation.
-
#authorization_info ⇒ Array<Google::Apis::ServicecontrolV1::AuthorizationInfo>
Authorization information.
-
#metadata ⇒ Hash<String,Object>
Other service-specific data about the request, response, and other information associated with the current audited event.
-
#method_name ⇒ String
The name of the service method or operation.
-
#num_response_items ⇒ Fixnum
The number of items returned from a List or Query API method, if applicable.
-
#request ⇒ Hash<String,Object>
The operation request.
-
#request_metadata ⇒ Google::Apis::ServicecontrolV1::RequestMetadata
Metadata about the request.
-
#resource_location ⇒ Google::Apis::ServicecontrolV1::ResourceLocation
Location information about a resource.
-
#resource_name ⇒ String
The resource or collection that is the target of the operation.
-
#resource_original_state ⇒ Hash<String,Object>
The resource's original state before mutation.
-
#response ⇒ Hash<String,Object>
The operation response.
-
#service_data ⇒ Hash<String,Object>
Deprecated, use
metadata
field instead. -
#service_name ⇒ String
The name of the API service performing the operation.
-
#status ⇒ Google::Apis::ServicecontrolV1::Status
The
Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
Instance Method Summary collapse
-
#initialize(**args) ⇒ AuditLog
constructor
A new instance of AuditLog.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ AuditLog
Returns a new instance of AuditLog.
301 302 303 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 301 def initialize(**args) update!(**args) end |
Instance Attribute Details
#authentication_info ⇒ Google::Apis::ServicecontrolV1::AuthenticationInfo
Authentication information for the operation.
Corresponds to the JSON property authenticationInfo
198 199 200 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 198 def authentication_info @authentication_info end |
#authorization_info ⇒ Array<Google::Apis::ServicecontrolV1::AuthorizationInfo>
Authorization information. If there are multiple
resources or permissions involved, then there is
one AuthorizationInfo element for each resource, permission
tuple.
Corresponds to the JSON property authorizationInfo
205 206 207 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 205 def @authorization_info end |
#metadata ⇒ Hash<String,Object>
Other service-specific data about the request, response, and other
information associated with the current audited event.
Corresponds to the JSON property metadata
211 212 213 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 211 def @metadata end |
#method_name ⇒ String
The name of the service method or operation.
For API calls, this should be the name of the API method.
For example,
"google.datastore.v1.Datastore.RunQuery"
"google.logging.v1.LoggingService.DeleteLog"
Corresponds to the JSON property methodName
220 221 222 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 220 def method_name @method_name end |
#num_response_items ⇒ Fixnum
The number of items returned from a List or Query API method,
if applicable.
Corresponds to the JSON property numResponseItems
226 227 228 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 226 def num_response_items @num_response_items end |
#request ⇒ Hash<String,Object>
The operation request. This may not include all request parameters,
such as those that are too large, privacy-sensitive, or duplicated
elsewhere in the log record.
It should never include user-generated data, such as file contents.
When the JSON object represented here has a proto equivalent, the proto
name will be indicated in the @type
property.
Corresponds to the JSON property request
236 237 238 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 236 def request @request end |
#request_metadata ⇒ Google::Apis::ServicecontrolV1::RequestMetadata
Metadata about the request.
Corresponds to the JSON property requestMetadata
241 242 243 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 241 def @request_metadata end |
#resource_location ⇒ Google::Apis::ServicecontrolV1::ResourceLocation
Location information about a resource.
Corresponds to the JSON property resourceLocation
246 247 248 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 246 def resource_location @resource_location end |
#resource_name ⇒ String
The resource or collection that is the target of the operation.
The name is a scheme-less URI, not including the API service name.
For example:
"shelves/SHELF_ID/books"
"shelves/SHELF_ID/books/BOOK_ID"
Corresponds to the JSON property resourceName
255 256 257 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 255 def resource_name @resource_name end |
#resource_original_state ⇒ Hash<String,Object>
The resource's original state before mutation. Present only for
operations which have successfully modified the targeted resource(s).
In general, this field should contain all changed fields, except those
that are already been included in request
, response
, metadata
or
service_data
fields.
When the JSON object represented here has a proto equivalent,
the proto name will be indicated in the @type
property.
Corresponds to the JSON property resourceOriginalState
266 267 268 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 266 def resource_original_state @resource_original_state end |
#response ⇒ Hash<String,Object>
The operation response. This may not include all response elements,
such as those that are too large, privacy-sensitive, or duplicated
elsewhere in the log record.
It should never include user-generated data, such as file contents.
When the JSON object represented here has a proto equivalent, the proto
name will be indicated in the @type
property.
Corresponds to the JSON property response
276 277 278 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 276 def response @response end |
#service_data ⇒ Hash<String,Object>
Deprecated, use metadata
field instead.
Other service-specific data about the request, response, and other
activities.
Corresponds to the JSON property serviceData
283 284 285 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 283 def service_data @service_data end |
#service_name ⇒ String
The name of the API service performing the operation. For example,
"datastore.googleapis.com"
.
Corresponds to the JSON property serviceName
289 290 291 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 289 def service_name @service_name end |
#status ⇒ Google::Apis::ServicecontrolV1::Status
The Status
type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It is
used by gRPC. Each Status
message contains
three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the
API Design Guide.
Corresponds to the JSON property status
299 300 301 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 299 def status @status end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 306 def update!(**args) @authentication_info = args[:authentication_info] if args.key?(:authentication_info) @authorization_info = args[:authorization_info] if args.key?(:authorization_info) @metadata = args[:metadata] if args.key?(:metadata) @method_name = args[:method_name] if args.key?(:method_name) @num_response_items = args[:num_response_items] if args.key?(:num_response_items) @request = args[:request] if args.key?(:request) @request_metadata = args[:request_metadata] if args.key?(:request_metadata) @resource_location = args[:resource_location] if args.key?(:resource_location) @resource_name = args[:resource_name] if args.key?(:resource_name) @resource_original_state = args[:resource_original_state] if args.key?(:resource_original_state) @response = args[:response] if args.key?(:response) @service_data = args[:service_data] if args.key?(:service_data) @service_name = args[:service_name] if args.key?(:service_name) @status = args[:status] if args.key?(:status) end |