Class: Google::Cloud::Filestore::V1::NfsExportOptions

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb

Overview

NFS export options specifications.

Defined Under Namespace

Modules: AccessMode, SquashMode

Instance Attribute Summary collapse

Instance Attribute Details

#access_mode ⇒ ::Google::Cloud::Filestore::V1::NfsExportOptions::AccessMode

Returns Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.

Returns:



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 147

class NfsExportOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The access mode.
  module AccessMode
    # AccessMode not set.
    ACCESS_MODE_UNSPECIFIED = 0

    # The client can only read the file share.
    READ_ONLY = 1

    # The client can read and write the file share (default).
    READ_WRITE = 2
  end

  # The squash mode.
  module SquashMode
    # SquashMode not set.
    SQUASH_MODE_UNSPECIFIED = 0

    # The Root user has root access to the file share (default).
    NO_ROOT_SQUASH = 1

    # The Root user has squashed access to the anonymous uid/gid.
    ROOT_SQUASH = 2
  end
end

#anon_gid ⇒ ::Integer

An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

Returns:

  • (::Integer) —

    An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 147

class NfsExportOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The access mode.
  module AccessMode
    # AccessMode not set.
    ACCESS_MODE_UNSPECIFIED = 0

    # The client can only read the file share.
    READ_ONLY = 1

    # The client can read and write the file share (default).
    READ_WRITE = 2
  end

  # The squash mode.
  module SquashMode
    # SquashMode not set.
    SQUASH_MODE_UNSPECIFIED = 0

    # The Root user has root access to the file share (default).
    NO_ROOT_SQUASH = 1

    # The Root user has squashed access to the anonymous uid/gid.
    ROOT_SQUASH = 2
  end
end

#anon_uid ⇒ ::Integer

An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

Returns:

  • (::Integer) —

    An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 147

class NfsExportOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The access mode.
  module AccessMode
    # AccessMode not set.
    ACCESS_MODE_UNSPECIFIED = 0

    # The client can only read the file share.
    READ_ONLY = 1

    # The client can read and write the file share (default).
    READ_WRITE = 2
  end

  # The squash mode.
  module SquashMode
    # SquashMode not set.
    SQUASH_MODE_UNSPECIFIED = 0

    # The Root user has root access to the file share (default).
    NO_ROOT_SQUASH = 1

    # The Root user has squashed access to the anonymous uid/gid.
    ROOT_SQUASH = 2
  end
end

#ip_ranges ⇒ ::Array<::String>

Returns List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.

Returns:

  • (::Array<::String>) —

    List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 147

class NfsExportOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The access mode.
  module AccessMode
    # AccessMode not set.
    ACCESS_MODE_UNSPECIFIED = 0

    # The client can only read the file share.
    READ_ONLY = 1

    # The client can read and write the file share (default).
    READ_WRITE = 2
  end

  # The squash mode.
  module SquashMode
    # SquashMode not set.
    SQUASH_MODE_UNSPECIFIED = 0

    # The Root user has root access to the file share (default).
    NO_ROOT_SQUASH = 1

    # The Root user has squashed access to the anonymous uid/gid.
    ROOT_SQUASH = 2
  end
end

#squash_mode ⇒ ::Google::Cloud::Filestore::V1::NfsExportOptions::SquashMode

Returns Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.

Returns:



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 147

class NfsExportOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The access mode.
  module AccessMode
    # AccessMode not set.
    ACCESS_MODE_UNSPECIFIED = 0

    # The client can only read the file share.
    READ_ONLY = 1

    # The client can read and write the file share (default).
    READ_WRITE = 2
  end

  # The squash mode.
  module SquashMode
    # SquashMode not set.
    SQUASH_MODE_UNSPECIFIED = 0

    # The Root user has root access to the file share (default).
    NO_ROOT_SQUASH = 1

    # The Root user has squashed access to the anonymous uid/gid.
    ROOT_SQUASH = 2
  end
end