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

Class: Aws::CodeCommit::Types::PutFileInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb

Overview

Note:

When making an API call, you may pass PutFileInput data as a hash:

{
  repository_name: "RepositoryName", # required
  branch_name: "BranchName", # required
  file_content: "data", # required
  file_path: "Path", # required
  file_mode: "EXECUTABLE", # accepts EXECUTABLE, NORMAL, SYMLINK
  parent_commit_id: "CommitId",
  commit_message: "Message",
  name: "Name",
  email: "Email",
}

Instance Attribute Summary collapse

Instance Attribute Details

#branch_nameString

The name of the branch where you want to add or update the file.

Returns:

  • (String)


2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2051

class PutFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_content,
  :file_path,
  :file_mode,
  :parent_commit_id,
  :commit_message,
  :name,
  :email)
  include Aws::Structure
end

#commit_messageString

A message about why this file was added or updated. While optional, adding a message is strongly encouraged in order to provide a more useful commit history for your repository.

Returns:

  • (String)


2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2051

class PutFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_content,
  :file_path,
  :file_mode,
  :parent_commit_id,
  :commit_message,
  :name,
  :email)
  include Aws::Structure
end

#emailString

An email address for the person adding or updating the file.

Returns:

  • (String)


2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2051

class PutFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_content,
  :file_path,
  :file_mode,
  :parent_commit_id,
  :commit_message,
  :name,
  :email)
  include Aws::Structure
end

#file_contentString

The content of the file, in binary object format.

Returns:

  • (String)


2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2051

class PutFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_content,
  :file_path,
  :file_mode,
  :parent_commit_id,
  :commit_message,
  :name,
  :email)
  include Aws::Structure
end

#file_modeString

The file mode permissions of the blob. Valid file mode permissions are listed below.

Returns:

  • (String)


2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2051

class PutFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_content,
  :file_path,
  :file_mode,
  :parent_commit_id,
  :commit_message,
  :name,
  :email)
  include Aws::Structure
end

#file_pathString

The name of the file you want to add or update, including the relative path to the file in the repository.

If the path does not currently exist in the repository, the path will be created as part of adding the file.

Returns:

  • (String)


2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2051

class PutFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_content,
  :file_path,
  :file_mode,
  :parent_commit_id,
  :commit_message,
  :name,
  :email)
  include Aws::Structure
end

#nameString

The name of the person adding or updating the file. While optional, adding a name is strongly encouraged in order to provide a more useful commit history for your repository.

Returns:

  • (String)


2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2051

class PutFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_content,
  :file_path,
  :file_mode,
  :parent_commit_id,
  :commit_message,
  :name,
  :email)
  include Aws::Structure
end

#parent_commit_idString

The full commit ID of the head commit in the branch where you want to add or update the file. If the commit ID does not match the ID of the head commit at the time of the operation, an error will occur, and the file will not be added or updated.

Returns:

  • (String)


2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2051

class PutFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_content,
  :file_path,
  :file_mode,
  :parent_commit_id,
  :commit_message,
  :name,
  :email)
  include Aws::Structure
end

#repository_nameString

The name of the repository where you want to add or update the file.

Returns:

  • (String)


2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2051

class PutFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_content,
  :file_path,
  :file_mode,
  :parent_commit_id,
  :commit_message,
  :name,
  :email)
  include Aws::Structure
end