Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDocResponse

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

The catalog item resource wrapped with response status, error_code, etc.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1ApiDocResponse

Returns a new instance of GoogleCloudApigeeV1ApiDocResponse.



965
966
967
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 965

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

Instance Attribute Details

#data ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiDoc

ApiDoc represents an API catalog item. Catalog items are used in two ways in a portal: - Users can browse and interact with a visual representation of the API documentation - The api_product_name field provides a link to a backing API product. Through this link, portal users can create and manage developer apps linked to one or more API products. Corresponds to the JSON property data

Returns:



943
944
945
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 943

def data
  @data
end

#error_code ⇒ String

Unique error code for the request, if any. Corresponds to the JSON property errorCode

Returns:

  • (String) 


948
949
950
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 948

def error_code
  @error_code
end

#message ⇒ String

Description of the operation. Corresponds to the JSON property message

Returns:

  • (String) 


953
954
955
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 953

def message
  @message
end

#request_id ⇒ String

Unique ID of the request. Corresponds to the JSON property requestId

Returns:

  • (String) 


958
959
960
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 958

def request_id
  @request_id
end

#status ⇒ String

Status of the operation. Corresponds to the JSON property status

Returns:

  • (String) 


963
964
965
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 963

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



970
971
972
973
974
975
976
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 970

def update!(**args)
  @data = args[:data] if args.key?(:data)
  @error_code = args[:error_code] if args.key?(:error_code)
  @message = args[:message] if args.key?(:message)
  @request_id = args[:request_id] if args.key?(:request_id)
  @status = args[:status] if args.key?(:status)
end