Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ExportRequest

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

Overview

Request body for [CreateExportRequest]

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

Returns a new instance of GoogleCloudApigeeV1ExportRequest.


2615
2616
2617
# File 'generated/google/apis/apigee_v1/classes.rb', line 2615

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

Instance Attribute Details

#csv_delimiterString

Optional. Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t). Corresponds to the JSON property csvDelimiter

Returns:

  • (String)

2586
2587
2588
# File 'generated/google/apis/apigee_v1/classes.rb', line 2586

def csv_delimiter
  @csv_delimiter
end

#datastore_nameString

Required. Name of the preconfigured datastore. Corresponds to the JSON property datastoreName

Returns:

  • (String)

2591
2592
2593
# File 'generated/google/apis/apigee_v1/classes.rb', line 2591

def datastore_name
  @datastore_name
end

#date_rangeGoogle::Apis::ApigeeV1::GoogleCloudApigeeV1DateRange

Date range of the data to export. Corresponds to the JSON property dateRange


2596
2597
2598
# File 'generated/google/apis/apigee_v1/classes.rb', line 2596

def date_range
  @date_range
end

#descriptionString

Optional. Description of the export job. Corresponds to the JSON property description

Returns:

  • (String)

2601
2602
2603
# File 'generated/google/apis/apigee_v1/classes.rb', line 2601

def description
  @description
end

#nameString

Required. Display name of the export job. Corresponds to the JSON property name

Returns:

  • (String)

2606
2607
2608
# File 'generated/google/apis/apigee_v1/classes.rb', line 2606

def name
  @name
end

#output_formatString

Optional. Output format of the export. Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property. Corresponds to the JSON property outputFormat

Returns:

  • (String)

2613
2614
2615
# File 'generated/google/apis/apigee_v1/classes.rb', line 2613

def output_format
  @output_format
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2620
2621
2622
2623
2624
2625
2626
2627
# File 'generated/google/apis/apigee_v1/classes.rb', line 2620

def update!(**args)
  @csv_delimiter = args[:csv_delimiter] if args.key?(:csv_delimiter)
  @datastore_name = args[:datastore_name] if args.key?(:datastore_name)
  @date_range = args[:date_range] if args.key?(:date_range)
  @description = args[:description] if args.key?(:description)
  @name = args[:name] if args.key?(:name)
  @output_format = args[:output_format] if args.key?(:output_format)
end