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.

Parameters:

  • name (String) —

    the name of this link

  • dataverse (String) —

    the dataverse this link belongs to

  • access_key_id (String) —

    AWS S3 access key ID

  • secret_access_key (String) —

    AWS S3 secret key

  • region (String) —

    AWS S3 region

  • session_token (String, nil) (defaults to: nil) —

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

  • service_endpoint (String, nil) (defaults to: nil) —

    AWS S3 service endpoint

Yield Parameters:



1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1132

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:

  • (String) 


1117
1118
1119
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1117

def access_key_id
  @access_key_id
end

#dataverse ⇒ String

Returns:

  • (String) 


1116
1117
1118
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1116

def dataverse
  @dataverse
end

#name ⇒ String

Returns:

  • (String) 


1115
1116
1117
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1115

def name
  @name
end

#region ⇒ String

Returns:

  • (String) 


1120
1121
1122
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1120

def region
  @region
end

#secret_access_key ⇒ String

Returns:

  • (String) 


1118
1119
1120
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1118

def secret_access_key
  @secret_access_key
end

#service_endpoint ⇒ String?

Returns:

  • (String, nil) 


1121
1122
1123
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1121

def service_endpoint
  @service_endpoint
end

#session_token ⇒ String?

Returns:

  • (String, nil) 


1119
1120
1121
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1119

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. 



1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1146

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