Class: Google::Apis::CesV1::OpenApiTool

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

Overview

A remote API tool defined by an OpenAPI schema.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OpenApiTool

Returns a new instance of OpenApiTool.



6554
6555
6556
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6554

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

Instance Attribute Details

#api_authentication ⇒ Google::Apis::CesV1::ApiAuthentication

Authentication information required for API calls. Corresponds to the JSON property apiAuthentication

Returns:



6509
6510
6511
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6509

def api_authentication
  @api_authentication
end

#description ⇒ String

Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from operation.description or operation.summary. Corresponds to the JSON property description

Returns:

  • (String) 


6516
6517
6518
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6516

def description
  @description
end

#ignore_unknown_fields ⇒ Boolean Also known as: ignore_unknown_fields?

Optional. If true, the agent will ignore unknown fields in the API response. Corresponds to the JSON property ignoreUnknownFields

Returns:

  • (Boolean) 


6521
6522
6523
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6521

def ignore_unknown_fields
  @ignore_unknown_fields
end

#name ⇒ String

Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from operation.operationId. Corresponds to the JSON property name

Returns:

  • (String) 


6528
6529
6530
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6528

def name
  @name
end

#open_api_schema ⇒ String

Required. The OpenAPI schema in JSON or YAML format. Corresponds to the JSON property openApiSchema

Returns:

  • (String) 


6533
6534
6535
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6533

def open_api_schema
  @open_api_schema
end

#service_directory_config ⇒ Google::Apis::CesV1::ServiceDirectoryConfig

Configuration for tools using Service Directory. Corresponds to the JSON property serviceDirectoryConfig

Returns:



6538
6539
6540
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6538

def service_directory_config
  @service_directory_config
end

#tls_config ⇒ Google::Apis::CesV1::TlsConfig

The TLS configuration. Corresponds to the JSON property tlsConfig

Returns:



6543
6544
6545
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6543

def tls_config
  @tls_config
end

#url ⇒ String

Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema. Corresponds to the JSON property url

Returns:

  • (String) 


6552
6553
6554
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6552

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6559

def update!(**args)
  @api_authentication = args[:api_authentication] if args.key?(:api_authentication)
  @description = args[:description] if args.key?(:description)
  @ignore_unknown_fields = args[:ignore_unknown_fields] if args.key?(:ignore_unknown_fields)
  @name = args[:name] if args.key?(:name)
  @open_api_schema = args[:open_api_schema] if args.key?(:open_api_schema)
  @service_directory_config = args[:service_directory_config] if args.key?(:service_directory_config)
  @tls_config = args[:tls_config] if args.key?(:tls_config)
  @url = args[:url] if args.key?(:url)
end