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

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/container/v1/doc/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::Container::V1::SetMasterAuthRequest::Action

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

Returns:



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1325

class SetMasterAuthRequest
  # 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

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

Returns:

  • (String) —

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



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1325

class SetMasterAuthRequest
  # 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/*'.



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1325

class SetMasterAuthRequest
  # 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

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

Returns:

  • (String) —

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



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1325

class SetMasterAuthRequest
  # 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::Container::V1::MasterAuth

Returns Required. A description of the update.

Returns:



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1325

class SetMasterAuthRequest
  # 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

Returns Required. 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) —

    Required. 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.



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 1325

class SetMasterAuthRequest
  # 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