Class: Couchbase::Management::S3ExternalAnalyticsLink

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/management/analytics_index_manager.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, dataverse, access_key_id, secret_access_key, region, session_token: nil, service_endpoint: nil) {|self| ... } ⇒ S3ExternalAnalyticsLink

Returns a new instance of S3ExternalAnalyticsLink.

Yield Parameters:

Parameters:

  • the name of this link

  • the dataverse this link belongs to

  • AWS S3 access key ID

  • AWS S3 secret key

  • AWS S3 region

  • (defaults to: nil)

    AWS S3 token if temporary credentials are provided. Only available in 7.0+

  • (defaults to: nil)

    AWS S3 service endpoint



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1101

def initialize(name, dataverse, access_key_id, secret_access_key, region,
               session_token: nil,
               service_endpoint: nil)
  @name = name
  @dataverse = dataverse
  @access_key_id = access_key_id
  @secret_access_key = secret_access_key
  @session_token = session_token
  @region = region
  @service_endpoint = service_endpoint
  yield self if block_given?
end

Instance Attribute Details

#access_key_id ⇒ String

Returns:



1086
1087
1088
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1086

def access_key_id
  @access_key_id
end

#dataverse ⇒ String

Returns:



1085
1086
1087
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1085

def dataverse
  @dataverse
end

#name ⇒ String

Returns:



1084
1085
1086
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1084

def name
  @name
end

#region ⇒ String

Returns:



1089
1090
1091
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1089

def region
  @region
end

#secret_access_key ⇒ String

Returns:



1087
1088
1089
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1087

def secret_access_key
  @secret_access_key
end

#service_endpoint ⇒ String?

Returns:



1090
1091
1092
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1090

def service_endpoint
  @service_endpoint
end

#session_token ⇒ String?

Returns:



1088
1089
1090
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1088

def session_token
  @session_token
end

Instance Method Details

#to_backend ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

API:

  • private



1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1115

def to_backend
  {
    type: :s3,
    link_name: @name,
    dataverse: @dataverse,
    access_key_id: @access_key_id,
    secret_access_key: @secret_access_key,
    session_token: @session_token,
    region: @region,
    service_endpoint: @service_endpoint,
  }
end