Class: Google::Apis::FileV1::Instance

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/file_v1/classes.rb,
lib/google/apis/file_v1/representations.rb,
lib/google/apis/file_v1/representations.rb

Overview

A Filestore instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



955
956
957
 
# File 'lib/google/apis/file_v1/classes.rb', line 955

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#configurable_performance_enabled ⇒ Boolean Also known as: configurable_performance_enabled?

Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. Corresponds to the JSON property configurablePerformanceEnabled

Returns:

  • (Boolean) 


829
830
831
 
# File 'lib/google/apis/file_v1/classes.rb', line 829

def configurable_performance_enabled
  @configurable_performance_enabled
end

#create_time ⇒ String

Output only. The time when the instance was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


835
836
837
 
# File 'lib/google/apis/file_v1/classes.rb', line 835

def create_time
  @create_time
end

#deletion_protection_enabled ⇒ Boolean Also known as: deletion_protection_enabled?

Optional. Indicates whether the instance is protected against deletion. Corresponds to the JSON property deletionProtectionEnabled

Returns:

  • (Boolean) 


840
841
842
 
# File 'lib/google/apis/file_v1/classes.rb', line 840

def deletion_protection_enabled
  @deletion_protection_enabled
end

#deletion_protection_reason ⇒ String

Optional. The reason for enabling deletion protection. Corresponds to the JSON property deletionProtectionReason

Returns:

  • (String) 


846
847
848
 
# File 'lib/google/apis/file_v1/classes.rb', line 846

def deletion_protection_reason
  @deletion_protection_reason
end

#description ⇒ String

The description of the instance (2048 characters or less). Corresponds to the JSON property description

Returns:

  • (String) 


851
852
853
 
# File 'lib/google/apis/file_v1/classes.rb', line 851

def description
  @description
end

#etag ⇒ String

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. Corresponds to the JSON property etag

Returns:

  • (String) 


857
858
859
 
# File 'lib/google/apis/file_v1/classes.rb', line 857

def etag
  @etag
end

#file_shares ⇒ Array<Google::Apis::FileV1::FileShareConfig>

File system shares on the instance. For this version, only a single file share is supported. Corresponds to the JSON property fileShares

Returns:



863
864
865
 
# File 'lib/google/apis/file_v1/classes.rb', line 863

def file_shares
  @file_shares
end

#kms_key_name ⇒ String

KMS key name used for data encryption. Corresponds to the JSON property kmsKeyName

Returns:

  • (String) 


868
869
870
 
# File 'lib/google/apis/file_v1/classes.rb', line 868

def kms_key_name
  @kms_key_name
end

#labels ⇒ Hash<String,String>

Resource labels to represent user provided metadata. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


873
874
875
 
# File 'lib/google/apis/file_v1/classes.rb', line 873

def labels
  @labels
end

#name ⇒ String

Output only. The resource name of the instance, in the format projects/ project/locations/location/instances/instance`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


879
880
881
 
# File 'lib/google/apis/file_v1/classes.rb', line 879

def name
  @name
end

#networks ⇒ Array<Google::Apis::FileV1::NetworkConfig>

VPC networks to which the instance is connected. For this version, only a single network is supported. Corresponds to the JSON property networks

Returns:



885
886
887
 
# File 'lib/google/apis/file_v1/classes.rb', line 885

def networks
  @networks
end

#performance_config ⇒ Google::Apis::FileV1::PerformanceConfig

Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). Corresponds to the JSON property performanceConfig

Returns:



895
896
897
 
# File 'lib/google/apis/file_v1/classes.rb', line 895

def performance_config
  @performance_config
end

#performance_limits ⇒ Google::Apis::FileV1::PerformanceLimits

The enforced performance limits, calculated from the instance's performance configuration. Corresponds to the JSON property performanceLimits

Returns:



901
902
903
 
# File 'lib/google/apis/file_v1/classes.rb', line 901

def performance_limits
  @performance_limits
end

#protocol ⇒ String

Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: NFS_V3. Corresponds to the JSON property protocol

Returns:

  • (String) 


908
909
910
 
# File 'lib/google/apis/file_v1/classes.rb', line 908

def protocol
  @protocol
end

#replication ⇒ Google::Apis::FileV1::Replication

Replication specifications. Corresponds to the JSON property replication

Returns:



913
914
915
 
# File 'lib/google/apis/file_v1/classes.rb', line 913

def replication
  @replication
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


918
919
920
 
# File 'lib/google/apis/file_v1/classes.rb', line 918

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


924
925
926
 
# File 'lib/google/apis/file_v1/classes.rb', line 924

def satisfies_pzs
  @satisfies_pzs
end

#state ⇒ String

Output only. The instance state. Corresponds to the JSON property state

Returns:

  • (String) 


930
931
932
 
# File 'lib/google/apis/file_v1/classes.rb', line 930

def state
  @state
end

#status_message ⇒ String

Output only. Additional information about the instance state, if available. Corresponds to the JSON property statusMessage

Returns:

  • (String) 


935
936
937
 
# File 'lib/google/apis/file_v1/classes.rb', line 935

def status_message
  @status_message
end

#suspension_reasons ⇒ Array<String>

Output only. Field indicates all the reasons the instance is in "SUSPENDED" state. Corresponds to the JSON property suspensionReasons

Returns:

  • (Array<String>) 


941
942
943
 
# File 'lib/google/apis/file_v1/classes.rb', line 941

def suspension_reasons
  @suspension_reasons
end

#tags ⇒ Hash<String,String>

Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": " marketing" Corresponds to the JSON property tags

Returns:

  • (Hash<String,String>) 


948
949
950
 
# File 'lib/google/apis/file_v1/classes.rb', line 948

def tags
  @tags
end

#tier ⇒ String

The service tier of the instance. Corresponds to the JSON property tier

Returns:

  • (String) 


953
954
955
 
# File 'lib/google/apis/file_v1/classes.rb', line 953

def tier
  @tier
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'lib/google/apis/file_v1/classes.rb', line 960

def update!(**args)
  @configurable_performance_enabled = args[:configurable_performance_enabled] if args.key?(:configurable_performance_enabled)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deletion_protection_enabled = args[:deletion_protection_enabled] if args.key?(:deletion_protection_enabled)
  @deletion_protection_reason = args[:deletion_protection_reason] if args.key?(:deletion_protection_reason)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @file_shares = args[:file_shares] if args.key?(:file_shares)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @networks = args[:networks] if args.key?(:networks)
  @performance_config = args[:performance_config] if args.key?(:performance_config)
  @performance_limits = args[:performance_limits] if args.key?(:performance_limits)
  @protocol = args[:protocol] if args.key?(:protocol)
  @replication = args[:replication] if args.key?(:replication)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @state = args[:state] if args.key?(:state)
  @status_message = args[:status_message] if args.key?(:status_message)
  @suspension_reasons = args[:suspension_reasons] if args.key?(:suspension_reasons)
  @tags = args[:tags] if args.key?(:tags)
  @tier = args[:tier] if args.key?(:tier)
end