GDC Hardware Management V1ALPHA API - Class Google::Cloud::GDCHardwareManagement::V1alpha::Site (v0.4.0)

Reference documentation and code samples for the GDC Hardware Management V1ALPHA API class Google::Cloud::GDCHardwareManagement::V1alpha::Site.

A physical site where hardware will be installed.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#access_times

def access_times() -> ::Array<::Google::Cloud::GDCHardwareManagement::V1alpha::TimePeriod>

Returns

(::Array<::Google::Cloud::GDCHardwareManagement::V1alpha::TimePeriod>) — Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.

This field is used by Google to schedule the initial installation as well as any later hardware maintenance. You may update this at any time. For example, if the initial installation is requested during off-hours but maintenance should be performed during regular business hours, you should update the access times after initial installation is complete.

#access_times=

def access_times=(value) -> ::Array<::Google::Cloud::GDCHardwareManagement::V1alpha::TimePeriod>

Parameter

value (::Array<::Google::Cloud::GDCHardwareManagement::V1alpha::TimePeriod>) — Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.

This field is used by Google to schedule the initial installation as well as any later hardware maintenance. You may update this at any time. For example, if the initial installation is requested during off-hours but maintenance should be performed during regular business hours, you should update the access times after initial installation is complete.

Returns

(::Array<::Google::Cloud::GDCHardwareManagement::V1alpha::TimePeriod>) — Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.

This field is used by Google to schedule the initial installation as well as any later hardware maintenance. You may update this at any time. For example, if the initial installation is requested during off-hours but maintenance should be performed during regular business hours, you should update the access times after initial installation is complete.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when this site was created.

#customer_site_id

def customer_site_id() -> ::String

Returns

(::String) — Optional. Customer defined identifier for this Site. This can be used to identify the site in the customer's own systems.

#customer_site_id=

def customer_site_id=(value) -> ::String

Parameter

value (::String) — Optional. Customer defined identifier for this Site. This can be used to identify the site in the customer's own systems.

Returns

(::String) — Optional. Customer defined identifier for this Site. This can be used to identify the site in the customer's own systems.

#description

def description() -> ::String

Returns

(::String) — Optional. Description of this Site.

#description=

def description=(value) -> ::String

Parameter

value (::String) — Optional. Description of this Site.

Returns

(::String) — Optional. Description of this Site.

#display_name

def display_name() -> ::String

Returns

(::String) — Optional. Display name of this Site.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — Optional. Display name of this Site.

Returns

(::String) — Optional. Display name of this Site.

#google_maps_pin_uri

def google_maps_pin_uri() -> ::String

Returns

(::String) — Optional. A URL to the Google Maps address location of the site. An example value is https://goo.gl/maps/xxxxxxxxx.

#google_maps_pin_uri=

def google_maps_pin_uri=(value) -> ::String

Parameter

value (::String) — Optional. A URL to the Google Maps address location of the site. An example value is https://goo.gl/maps/xxxxxxxxx.

Returns

(::String) — Optional. A URL to the Google Maps address location of the site. An example value is https://goo.gl/maps/xxxxxxxxx.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. Labels associated with this site as key value pairs. For more information about labels, see Create and manage labels.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels associated with this site as key value pairs. For more information about labels, see Create and manage labels.

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. Labels associated with this site as key value pairs. For more information about labels, see Create and manage labels.

#name

def name() -> ::String

Returns

(::String) — Identifier. Name of the site. Format: projects/{project}/locations/{location}/sites/{site}

#name=

def name=(value) -> ::String

Parameter

value (::String) — Identifier. Name of the site. Format: projects/{project}/locations/{location}/sites/{site}

Returns

(::String) — Identifier. Name of the site. Format: projects/{project}/locations/{location}/sites/{site}

#notes

def notes() -> ::String

Returns

(::String) —
Optional. Any additional notes for this Site. Please include information about:
- security or access restrictions
- any regulations affecting the technicians visiting the site
- any special process or approval required to move the equipment
- whether a representative will be available during site visits

#notes=

def notes=(value) -> ::String

Parameter

value (::String) —
Optional. Any additional notes for this Site. Please include information about:
- security or access restrictions
- any regulations affecting the technicians visiting the site
- any special process or approval required to move the equipment
- whether a representative will be available during site visits

Returns

(::String) —
Optional. Any additional notes for this Site. Please include information about:
- security or access restrictions
- any regulations affecting the technicians visiting the site
- any special process or approval required to move the equipment
- whether a representative will be available during site visits

#organization_contact

def organization_contact() -> ::Google::Cloud::GDCHardwareManagement::V1alpha::OrganizationContact

Returns

(::Google::Cloud::GDCHardwareManagement::V1alpha::OrganizationContact) — Required. Contact information for this site.

#organization_contact=

def organization_contact=(value) -> ::Google::Cloud::GDCHardwareManagement::V1alpha::OrganizationContact

Parameter

value (::Google::Cloud::GDCHardwareManagement::V1alpha::OrganizationContact) — Required. Contact information for this site.

Returns

(::Google::Cloud::GDCHardwareManagement::V1alpha::OrganizationContact) — Required. Contact information for this site.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when this site was last updated.