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.



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

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) 


819
820
821
 
# File 'lib/google/apis/file_v1/classes.rb', line 819

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) 


825
826
827
 
# File 'lib/google/apis/file_v1/classes.rb', line 825

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) 


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

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) 


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

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) 


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

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) 


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

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:



853
854
855
 
# File 'lib/google/apis/file_v1/classes.rb', line 853

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) 


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

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>) 


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

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) 


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

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:



875
876
877
 
# File 'lib/google/apis/file_v1/classes.rb', line 875

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:



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

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:



891
892
893
 
# File 'lib/google/apis/file_v1/classes.rb', line 891

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) 


898
899
900
 
# File 'lib/google/apis/file_v1/classes.rb', line 898

def protocol
  @protocol
end

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

Replication specifications. Corresponds to the JSON property replication

Returns:



903
904
905
 
# File 'lib/google/apis/file_v1/classes.rb', line 903

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) 


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

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) 


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

def satisfies_pzs
  @satisfies_pzs
end

#state ⇒ String

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

Returns:

  • (String) 


920
921
922
 
# File 'lib/google/apis/file_v1/classes.rb', line 920

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) 


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

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>) 


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

def suspension_reasons
  @suspension_reasons
end

#tags ⇒ Hash<String,String>

Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: " 123456789012/environment" : "production", "123456789013/costCenter" : " marketing" See the documentation for more information: - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing# retrieving_tag_key - Short name: https://cloud.google.com/resource-manager/ docs/tags/tags-creating-and-managing#retrieving_tag_value Corresponds to the JSON property tags

Returns:

  • (Hash<String,String>) 


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

def tags
  @tags
end

#tier ⇒ String

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

Returns:

  • (String) 


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

def tier
  @tier
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/google/apis/file_v1/classes.rb', line 954

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