Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Result

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/apigee_v1/classes.rb,
lib/google/apis/apigee_v1/representations.rb,
lib/google/apis/apigee_v1/representations.rb

Overview

Result is short for "action result", could be different types identified by " action_result" field. Supported types: 1. DebugInfo : generic debug info collected by runtime recorded as a list of properties. For example, the contents could be virtual host info, state change result, or execution metadata. Required fields : properties, timestamp 2. RequestMessage: information of a http request. Contains headers, request URI and http methods type.Required fields : headers, uri, verb 3. ResponseMessage: information of a http response. Contains headers, reason phrase and http status code. Required fields : headers, reasonPhrase, statusCode 4. ErrorMessage: information of a http error message. Contains detail error message, reason phrase and status code. Required fields : content, headers, reasonPhrase, statusCode 5. VariableAccess: a list of variable access actions, can be Get, Set and Remove. Required fields : accessList

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1Result

Returns a new instance of GoogleCloudApigeeV1Result.



6678
6679
6680
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6678

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#access_list ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1Access>

A list of variable access actions agaist the api proxy. Supported values: Get, Set, Remove. Corresponds to the JSON property accessList

Returns:



6631
6632
6633
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6631

def access_list
  @access_list
end

#action_result ⇒ String

Type of the action result. Can be one of the five: DebugInfo, RequestMessage, ResponseMessage, ErrorMessage, VariableAccess Corresponds to the JSON property ActionResult

Returns:

  • (String) 


6625
6626
6627
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6625

def action_result
  @action_result
end

#content ⇒ String

Error message content. for example, "content" : "\"fault\":\"faultstring\":\" API timed out\",\"detail\":\"errorcode\":\"flow.APITimedOut\"`" Corresponds to the JSON propertycontent`

Returns:

  • (String) 


6637
6638
6639
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6637

def content
  @content
end

#headers ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1Property>

A list of HTTP headers. for example, '"headers" : [ "name" : "Content-Length" , "value" : "83", "name" : "Content-Type", "value" : "application/json" ] ' Corresponds to the JSON property headers

Returns:



6644
6645
6646
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6644

def headers
  @headers
end

#properties ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Properties

Message for compatibility with legacy Edge specification for Java Properties object in JSON. Corresponds to the JSON property properties

Returns:



6650
6651
6652
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6650

def properties
  @properties
end

#reason_phrase ⇒ String

HTTP response phrase Corresponds to the JSON property reasonPhrase

Returns:

  • (String) 


6655
6656
6657
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6655

def reason_phrase
  @reason_phrase
end

#status_code ⇒ String

HTTP response code Corresponds to the JSON property statusCode

Returns:

  • (String) 


6660
6661
6662
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6660

def status_code
  @status_code
end

#timestamp ⇒ String

Timestamp of when the result is recorded. Its format is dd-mm-yy hh:mm:ss:xxx. For example, "timestamp" : "12-08-19 00:31:59:960" Corresponds to the JSON property timestamp

Returns:

  • (String) 


6666
6667
6668
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6666

def timestamp
  @timestamp
end

#u_ri ⇒ String

The relative path of the api proxy. for example, "uRI" : "/iloveapis" Corresponds to the JSON property uRI

Returns:

  • (String) 


6671
6672
6673
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6671

def u_ri
  @u_ri
end

#verb ⇒ String

HTTP method verb Corresponds to the JSON property verb

Returns:

  • (String) 


6676
6677
6678
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6676

def verb
  @verb
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6683

def update!(**args)
  @action_result = args[:action_result] if args.key?(:action_result)
  @access_list = args[:access_list] if args.key?(:access_list)
  @content = args[:content] if args.key?(:content)
  @headers = args[:headers] if args.key?(:headers)
  @properties = args[:properties] if args.key?(:properties)
  @reason_phrase = args[:reason_phrase] if args.key?(:reason_phrase)
  @status_code = args[:status_code] if args.key?(:status_code)
  @timestamp = args[:timestamp] if args.key?(:timestamp)
  @u_ri = args[:u_ri] if args.key?(:u_ri)
  @verb = args[:verb] if args.key?(:verb)
end