Class: Google::Cloud::Container::V1::SetMasterAuthRequest

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

Overview

SetMasterAuthRequest updates the admin password of a cluster.

Defined Under Namespace

Modules: Action

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ ::Google::Cloud::Container::V1::SetMasterAuthRequest::Action

Returns Required. The exact form of action to be taken on the master auth.

Returns:



2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 2951

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

  # Operation type: what type update to perform.
  module Action
    # Operation is unknown and will error out.
    UNKNOWN = 0

    # Set the password to a user generated value.
    SET_PASSWORD = 1

    # Generate a new password and set it to that.
    GENERATE_PASSWORD = 2

    # Set the username.  If an empty username is provided, basic authentication
    # is disabled for the cluster.  If a non-empty username is provided, basic
    # authentication is enabled, with either a provided password or a generated
    # one.
    SET_USERNAME = 3
  end
end

#cluster_id ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Returns:

  • (::String) —

    Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.



2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 2951

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

  # Operation type: what type update to perform.
  module Action
    # Operation is unknown and will error out.
    UNKNOWN = 0

    # Set the password to a user generated value.
    SET_PASSWORD = 1

    # Generate a new password and set it to that.
    GENERATE_PASSWORD = 2

    # Set the username.  If an empty username is provided, basic authentication
    # is disabled for the cluster.  If a non-empty username is provided, basic
    # authentication is enabled, with either a provided password or a generated
    # one.
    SET_USERNAME = 3
  end
end

#name ⇒ ::String

Returns The name (project, location, cluster) of the cluster to set auth. Specified in the format projects/*/locations/*/clusters/*.

Returns:

  • (::String) —

    The name (project, location, cluster) of the cluster to set auth. Specified in the format projects/*/locations/*/clusters/*.



2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 2951

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

  # Operation type: what type update to perform.
  module Action
    # Operation is unknown and will error out.
    UNKNOWN = 0

    # Set the password to a user generated value.
    SET_PASSWORD = 1

    # Generate a new password and set it to that.
    GENERATE_PASSWORD = 2

    # Set the username.  If an empty username is provided, basic authentication
    # is disabled for the cluster.  If a non-empty username is provided, basic
    # authentication is enabled, with either a provided password or a generated
    # one.
    SET_USERNAME = 3
  end
end

#project_id ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Returns:

  • (::String) —

    Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.



2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 2951

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

  # Operation type: what type update to perform.
  module Action
    # Operation is unknown and will error out.
    UNKNOWN = 0

    # Set the password to a user generated value.
    SET_PASSWORD = 1

    # Generate a new password and set it to that.
    GENERATE_PASSWORD = 2

    # Set the username.  If an empty username is provided, basic authentication
    # is disabled for the cluster.  If a non-empty username is provided, basic
    # authentication is enabled, with either a provided password or a generated
    # one.
    SET_USERNAME = 3
  end
end

#update ⇒ ::Google::Cloud::Container::V1::MasterAuth

Returns Required. A description of the update.

Returns:



2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 2951

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

  # Operation type: what type update to perform.
  module Action
    # Operation is unknown and will error out.
    UNKNOWN = 0

    # Set the password to a user generated value.
    SET_PASSWORD = 1

    # Generate a new password and set it to that.
    GENERATE_PASSWORD = 2

    # Set the username.  If an empty username is provided, basic authentication
    # is disabled for the cluster.  If a non-empty username is provided, basic
    # authentication is enabled, with either a provided password or a generated
    # one.
    SET_USERNAME = 3
  end
end

#zone ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

Returns:

  • (::String) —

    Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.



2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 2951

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

  # Operation type: what type update to perform.
  module Action
    # Operation is unknown and will error out.
    UNKNOWN = 0

    # Set the password to a user generated value.
    SET_PASSWORD = 1

    # Generate a new password and set it to that.
    GENERATE_PASSWORD = 2

    # Set the username.  If an empty username is provided, basic authentication
    # is disabled for the cluster.  If a non-empty username is provided, basic
    # authentication is enabled, with either a provided password or a generated
    # one.
    SET_USERNAME = 3
  end
end