Class: Google::Apis::ServicecontrolV1::AuditLog

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AuditLog

Returns a new instance of AuditLog



236
237
238
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 236

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

Returns:



133
134
135
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 133

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

Returns:



140
141
142
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 140

def authorization_info
  @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

Returns:

  • (Hash<String,Object>) 


146
147
148
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 146

def metadata
  @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

Returns:

  • (String) 


155
156
157
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 155

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

Returns:

  • (Fixnum) 


161
162
163
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 161

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

Returns:

  • (Hash<String,Object>) 


171
172
173
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 171

def request
  @request
end

#request_metadata ⇒ Google::Apis::ServicecontrolV1::RequestMetadata

Metadata about the request. Corresponds to the JSON property requestMetadata

Returns:



176
177
178
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 176

def request_metadata
  @request_metadata
end

#resource_location ⇒ Google::Apis::ServicecontrolV1::ResourceLocation

Location information about a resource. Corresponds to the JSON property resourceLocation

Returns:



181
182
183
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 181

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

Returns:

  • (String) 


190
191
192
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 190

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

Returns:

  • (Hash<String,Object>) 


201
202
203
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 201

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

Returns:

  • (Hash<String,Object>) 


211
212
213
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 211

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

Returns:

  • (Hash<String,Object>) 


218
219
220
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 218

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

Returns:

  • (String) 


224
225
226
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 224

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

Returns:



234
235
236
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 234

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 241

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