You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::S3::BucketTagging

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_name, options = {}) ⇒ BucketTagging #initialize(options = {}) ⇒ BucketTagging

Returns a new instance of BucketTagging

Overloads:

  • #initialize(bucket_name, options = {}) ⇒ BucketTagging

    Parameters:

    • bucket_name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ BucketTagging

    Options Hash (options):

    • :bucket_name (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @bucket_name = extract_bucket_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#bucketBucket

Returns:



112
113
114
115
116
117
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 112

def bucket
  Bucket.new(
    name: @bucket_name,
    client: @client
  )
end

#bucket_nameString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 29

def bucket_name
  @bucket_name
end

#clientClient

Returns:



41
42
43
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 41

def client
  @client
end

#dataTypes::GetBucketTaggingOutput

Returns the data for this Aws::S3::BucketTagging. Calls Client#get_bucket_tagging if #data_loaded? is false.

Returns:



61
62
63
64
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 61

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



69
70
71
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 69

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


bucket_tagging.delete()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:

  • (EmptyStructure)


80
81
82
83
84
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 80

def delete(options = {})
  options = options.merge(bucket: @bucket_name)
  resp = @client.delete_bucket_tagging(options)
  resp.data
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::S3::BucketTagging. Returns self making it possible to chain methods.

bucket_tagging.reload.data

Returns:

  • (self)


51
52
53
54
55
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 51

def load
  resp = @client.get_bucket_tagging(bucket: @bucket_name)
  @data = resp.data
  self
end

#put(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


bucket_tagging.put({
  content_md5: "ContentMD5",
  tagging: { # required
    tag_set: [ # required
      {
        key: "ObjectKey", # required
        value: "Value", # required
      },
    ],
  },
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

Returns:

  • (EmptyStructure)


103
104
105
106
107
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 103

def put(options = {})
  options = options.merge(bucket: @bucket_name)
  resp = @client.put_bucket_tagging(options)
  resp.data
end

#tag_setArray<Types::Tag>

Returns:



34
35
36
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/bucket_tagging.rb', line 34

def tag_set
  data.tag_set
end