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



258
259
260
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 258

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:



138
139
140
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 138

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:



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

def authorization_info
  @authorization_info
end

#metadata ⇒ Array<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:

  • (Array<Hash<String,Object>>) 


151
152
153
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 151

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) 


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

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) 


166
167
168
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 166

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>) 


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

def request
  @request
end

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

Metadata about the request. Corresponds to the JSON property requestMetadata

Returns:



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

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

#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>) 


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

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>) 


207
208
209
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 207

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) 


213
214
215
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 213

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. The error model is designed to be:

  • Simple to use and understand for most users
  • Flexible enough to meet unexpected needs # Overview The Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions. # Language mapping The Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include:
  • Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
  • Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
  • Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
  • Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
  • Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. Corresponds to the JSON property status

Returns:



256
257
258
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 256

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 263

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_name = args[:resource_name] if args.key?(:resource_name)
  @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